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.

Classes

NameDescription
Class AccessDeniedException

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

Class AddFacetToObjectRequest

Container for the parameters to the AddFacetToObject operation. Adds a new Facet to an object. An object can have more than one facet applied on it.

Class AddFacetToObjectResponse

This is the response object from the AddFacetToObject operation.

Class ApplySchemaRequest

Container for the parameters to the ApplySchema operation. Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

Class ApplySchemaResponse

This is the response object from the ApplySchema operation.

Class AttachObjectRequest

Container for the parameters to the AttachObject operation. Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

Class AttachObjectResponse

This is the response object from the AttachObject operation.

Class AttachPolicyRequest

Container for the parameters to the AttachPolicy operation. Attaches a policy object to a regular object. An object can have a limited number of attached policies.

Class AttachPolicyResponse

This is the response object from the AttachPolicy operation.

Class AttachToIndexRequest

Container for the parameters to the AttachToIndex operation. Attaches the specified object to the specified index.

Class AttachToIndexResponse

This is the response object from the AttachToIndex operation.

Class AttachTypedLinkRequest

Container for the parameters to the AttachTypedLink operation. Attaches a typed link to a specified source and target object. For more information, see Typed Links.

Class AttachTypedLinkResponse

This is the response object from the AttachTypedLink operation.

Class AttributeKey

A unique identifier for an attribute.

Class AttributeKeyAndValue

The combination of an attribute key and an attribute value.

Class AttributeNameAndValue

Identifies the attribute name and value for a typed link.

Class BatchAddFacetToObject

Represents the output of a batch add facet to object operation.

Class BatchAddFacetToObjectResponse

The result of a batch add facet to object operation.

Class BatchAttachObject

Represents the output of an AttachObject operation.

Class BatchAttachObjectResponse

Represents the output batch AttachObject response operation.

Class BatchAttachPolicy

Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.

Class BatchAttachPolicyResponse

Represents the output of an AttachPolicy response operation.

Class BatchAttachToIndex

Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.

Class BatchAttachToIndexResponse

Represents the output of a AttachToIndex response operation.

Class BatchAttachTypedLink

Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.

Class BatchAttachTypedLinkResponse

Represents the output of a AttachTypedLink response operation.

Class BatchCreateIndex

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

Class BatchCreateIndexResponse

Represents the output of a CreateIndex response operation.

Class BatchCreateObject

Represents the output of a CreateObject operation.

Class BatchCreateObjectResponse

Represents the output of a CreateObject response operation.

Class BatchDeleteObject

Represents the output of a DeleteObject operation.

Class BatchDeleteObjectResponse

Represents the output of a DeleteObject response operation.

Class BatchDetachFromIndex

Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.

Class BatchDetachFromIndexResponse

Represents the output of a DetachFromIndex response operation.

Class BatchDetachObject

Represents the output of a DetachObject operation.

Class BatchDetachObjectResponse

Represents the output of a DetachObject response operation.

Class BatchDetachPolicy

Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.

Class BatchDetachPolicyResponse

Represents the output of a DetachPolicy response operation.

Class BatchDetachTypedLink

Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.

Class BatchDetachTypedLinkResponse

Represents the output of a DetachTypedLink response operation.

Class BatchGetLinkAttributes

Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.

Class BatchGetLinkAttributesResponse

Represents the output of a GetLinkAttributes response operation.

Class BatchGetObjectAttributes

Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations.

Class BatchGetObjectAttributesResponse

Represents the output of a GetObjectAttributes response operation.

Class BatchGetObjectInformation

Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.

Class BatchGetObjectInformationResponse

Represents the output of a GetObjectInformation response operation.

Class BatchListAttachedIndices

Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.

Class BatchListAttachedIndicesResponse

Represents the output of a ListAttachedIndices response operation.

Class BatchListIncomingTypedLinks

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations.

Class BatchListIncomingTypedLinksResponse

Represents the output of a ListIncomingTypedLinks response operation.

Class BatchListIndex

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

Class BatchListIndexResponse

Represents the output of a ListIndex response operation.

Class BatchListObjectAttributes

Represents the output of a ListObjectAttributes operation.

Class BatchListObjectAttributesResponse

Represents the output of a ListObjectAttributes response operation.

Class BatchListObjectChildren

Represents the output of a ListObjectChildren operation.

Class BatchListObjectChildrenResponse

Represents the output of a ListObjectChildren response operation.

Class BatchListObjectParentPaths

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations.

Class BatchListObjectParentPathsResponse

Represents the output of a ListObjectParentPaths response operation.

Class BatchListObjectParents

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

Class BatchListObjectParentsResponse

Represents the output of a ListObjectParents response operation.

Class BatchListObjectPolicies

Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.

Class BatchListObjectPoliciesResponse

Represents the output of a ListObjectPolicies response operation.

Class BatchListOutgoingTypedLinks

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

Class BatchListOutgoingTypedLinksResponse

Represents the output of a ListOutgoingTypedLinks response operation.

Class BatchListPolicyAttachments

Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.

Class BatchListPolicyAttachmentsResponse

Represents the output of a ListPolicyAttachments response operation.

Class BatchLookupPolicy

Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations.

Class BatchLookupPolicyResponse

Represents the output of a LookupPolicy response operation.

Class BatchReadException

The batch read exception structure, which contains the exception type and message.

Class BatchReadOperation

Represents the output of a BatchRead operation.

Class BatchReadOperationResponse

Represents the output of a BatchRead response operation.

Class BatchReadRequest

Container for the parameters to the BatchRead operation. Performs all the read operations in a batch.

Class BatchReadResponse

This is the response object from the BatchRead operation.

Class BatchReadSuccessfulResponse

Represents the output of a BatchRead success response operation.

Class BatchRemoveFacetFromObject

A batch operation to remove a facet from an object.

Class BatchRemoveFacetFromObjectResponse

An empty result that represents success.

Class BatchUpdateLinkAttributes

Updates a given typed link’s attributes inside a BatchRead operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. For more information, see UpdateLinkAttributes and BatchReadRequest$Operations.

Class BatchUpdateLinkAttributesResponse

Represents the output of a UpdateLinkAttributes response operation.

Class BatchUpdateObjectAttributes

Represents the output of a BatchUpdate operation.

Class BatchUpdateObjectAttributesResponse

Represents the output of a BatchUpdate response operation.

Class BatchWriteException

A BatchWrite exception has occurred.

Class BatchWriteOperation

Represents the output of a BatchWrite operation.

Class BatchWriteOperationResponse

Represents the output of a BatchWrite response operation.

Class BatchWriteRequest

Container for the parameters to the BatchWrite operation. Performs all the write operations in a batch. Either all the operations succeed or none.

Class BatchWriteResponse

This is the response object from the BatchWrite operation.

Class CannotListParentOfRootException

Cannot list the parents of a Directory root.

Class CloudDirectoryPaginatorFactory

Paginators for the CloudDirectory service

Class CreateDirectoryRequest

Container for the parameters to the CreateDirectory operation. 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.

Class CreateDirectoryResponse

This is the response object from the CreateDirectory operation.

Class CreateFacetRequest

Container for the parameters to the CreateFacet operation. Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

Class CreateFacetResponse

This is the response object from the CreateFacet operation.

Class CreateIndexRequest

Container for the parameters to the CreateIndex operation. Creates an index object. See Indexing and search for more information.

Class CreateIndexResponse

This is the response object from the CreateIndex operation.

Class CreateObjectRequest

Container for the parameters to the CreateObject operation. 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.

Class CreateObjectResponse

This is the response object from the CreateObject operation.

Class CreateSchemaRequest

Container for the parameters to the CreateSchema operation. 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.

Class CreateSchemaResponse

This is the response object from the CreateSchema operation.

Class CreateTypedLinkFacetRequest

Container for the parameters to the CreateTypedLinkFacet operation. Creates a TypedLinkFacet. For more information, see Typed Links.

Class CreateTypedLinkFacetResponse

This is the response object from the CreateTypedLinkFacet operation.

Class DeleteDirectoryRequest

Container for the parameters to the DeleteDirectory operation. Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

Class DeleteDirectoryResponse

This is the response object from the DeleteDirectory operation.

Class DeleteFacetRequest

Container for the parameters to the DeleteFacet operation. Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

Class DeleteFacetResponse

This is the response object from the DeleteFacet operation.

Class DeleteObjectRequest

Container for the parameters to the DeleteObject operation. 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.

Class DeleteObjectResponse

This is the response object from the DeleteObject operation.

Class DeleteSchemaRequest

Container for the parameters to the DeleteSchema operation. Deletes a given schema. Schemas in a development and published state can only be deleted.

Class DeleteSchemaResponse

This is the response object from the DeleteSchema operation.

Class DeleteTypedLinkFacetRequest

Container for the parameters to the DeleteTypedLinkFacet operation. Deletes a TypedLinkFacet. For more information, see Typed Links.

Class DeleteTypedLinkFacetResponse

This is the response object from the DeleteTypedLinkFacet operation.

Class DetachFromIndexRequest

Container for the parameters to the DetachFromIndex operation. Detaches the specified object from the specified index.

Class DetachFromIndexResponse

This is the response object from the DetachFromIndex operation.

Class DetachObjectRequest

Container for the parameters to the DetachObject operation. Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

Class DetachObjectResponse

This is the response object from the DetachObject operation.

Class DetachPolicyRequest

Container for the parameters to the DetachPolicy operation. Detaches a policy from an object.

Class DetachPolicyResponse

This is the response object from the DetachPolicy operation.

Class DetachTypedLinkRequest

Container for the parameters to the DetachTypedLink operation. Detaches a typed link from a specified source and target object. For more information, see Typed Links.

Class DetachTypedLinkResponse

This is the response object from the DetachTypedLink operation.

Class Directory

Directory structure that includes the directory name and directory ARN.

Class DirectoryAlreadyExistsException

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

Class DirectoryDeletedException

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

Class DirectoryNotDisabledException

An operation can only operate on a disabled directory.

Class DirectoryNotEnabledException

Operations are only permitted on enabled directories.

Class DisableDirectoryRequest

Container for the parameters to the DisableDirectory operation. Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

Class DisableDirectoryResponse

This is the response object from the DisableDirectory operation.

Class EnableDirectoryRequest

Container for the parameters to the EnableDirectory operation. Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

Class EnableDirectoryResponse

This is the response object from the EnableDirectory operation.

Class Facet

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See Facets for more information.

Class FacetAlreadyExistsException

A facet with the same name already exists.

Class FacetAttribute

An attribute that is associated with the Facet.

Class FacetAttributeDefinition

A facet attribute definition. See Attribute References for more information.

Class FacetAttributeReference

The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.

Class FacetAttributeUpdate

A structure that contains information used to update an attribute.

Class FacetInUseException

Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.

Class FacetNotFoundException

The specified Facet could not be found.

Class FacetValidationException

The Facet that you provided was not well formed or could not be validated with the schema.

Class GetAppliedSchemaVersionRequest

Container for the parameters to the GetAppliedSchemaVersion operation. Returns current applied schema version ARN, including the minor version in use.

Class GetAppliedSchemaVersionResponse

This is the response object from the GetAppliedSchemaVersion operation.

Class GetDirectoryRequest

Container for the parameters to the GetDirectory operation. Retrieves metadata about a directory.

Class GetDirectoryResponse

This is the response object from the GetDirectory operation.

Class GetFacetRequest

Container for the parameters to the GetFacet operation. 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.

Class GetFacetResponse

This is the response object from the GetFacet operation.

Class GetLinkAttributesRequest

Container for the parameters to the GetLinkAttributes operation. Retrieves attributes that are associated with a typed link.

Class GetLinkAttributesResponse

This is the response object from the GetLinkAttributes operation.

Class GetObjectAttributesRequest

Container for the parameters to the GetObjectAttributes operation. Retrieves attributes within a facet that are associated with an object.

Class GetObjectAttributesResponse

This is the response object from the GetObjectAttributes operation.

Class GetObjectInformationRequest

Container for the parameters to the GetObjectInformation operation. Retrieves metadata about an object.

Class GetObjectInformationResponse

This is the response object from the GetObjectInformation operation.

Class GetSchemaAsJsonRequest

Container for the parameters to the GetSchemaAsJson operation. Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

Class GetSchemaAsJsonResponse

This is the response object from the GetSchemaAsJson operation.

Class GetTypedLinkFacetInformationRequest

Container for the parameters to the GetTypedLinkFacetInformation operation. Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

Class GetTypedLinkFacetInformationResponse

This is the response object from the GetTypedLinkFacetInformation operation.

Class IncompatibleSchemaException

Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.

Class IndexAttachment

Represents an index and an attached object.

Class IndexedAttributeMissingException

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

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

Class InvalidArnException

Indicates that the provided ARN value is not valid.

Class InvalidAttachmentException

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

Class InvalidFacetUpdateException

An attempt to modify a Facet resulted in an invalid schema exception.

Class InvalidNextTokenException

Indicates that the NextToken value is not valid.

Class InvalidRuleException

Occurs when any of the rule parameter keys or values are invalid.

Class InvalidSchemaDocException

Indicates that the provided SchemaDoc value is not valid.

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

Class LimitExceededException

Indicates that limits are exceeded. See Limits for more information.

Class LinkAttributeAction

The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.

Class LinkAttributeUpdate

Structure that contains attribute update information.

Class LinkNameAlreadyInUseException

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

Class ListAppliedSchemaArnsRequest

Container for the parameters to the ListAppliedSchemaArns operation. Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

Class ListAppliedSchemaArnsResponse

This is the response object from the ListAppliedSchemaArns operation.

Class ListAttachedIndicesRequest

Container for the parameters to the ListAttachedIndices operation. Lists indices attached to the specified object.

Class ListAttachedIndicesResponse

This is the response object from the ListAttachedIndices operation.

Class ListDevelopmentSchemaArnsRequest

Container for the parameters to the ListDevelopmentSchemaArns operation. Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

Class ListDevelopmentSchemaArnsResponse

This is the response object from the ListDevelopmentSchemaArns operation.

Class ListDirectoriesRequest

Container for the parameters to the ListDirectories operation. Lists directories created within an account.

Class ListDirectoriesResponse

This is the response object from the ListDirectories operation.

Class ListFacetAttributesRequest

Container for the parameters to the ListFacetAttributes operation. Retrieves attributes attached to the facet.

Class ListFacetAttributesResponse

This is the response object from the ListFacetAttributes operation.

Class ListFacetNamesRequest

Container for the parameters to the ListFacetNames operation. Retrieves the names of facets that exist in a schema.

Class ListFacetNamesResponse

This is the response object from the ListFacetNames operation.

Class ListIncomingTypedLinksRequest

Container for the parameters to the ListIncomingTypedLinks operation. 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.

Class ListIncomingTypedLinksResponse

This is the response object from the ListIncomingTypedLinks operation.

Class ListIndexRequest

Container for the parameters to the ListIndex operation. Lists objects attached to the specified index.

Class ListIndexResponse

This is the response object from the ListIndex operation.

Class ListManagedSchemaArnsRequest

Container for the parameters to the ListManagedSchemaArns operation. 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.

Class ListManagedSchemaArnsResponse

This is the response object from the ListManagedSchemaArns operation.

Class ListObjectAttributesRequest

Container for the parameters to the ListObjectAttributes operation. Lists all attributes that are associated with an object.

Class ListObjectAttributesResponse

This is the response object from the ListObjectAttributes operation.

Class ListObjectChildrenRequest

Container for the parameters to the ListObjectChildren operation. Returns a paginated list of child objects that are associated with a given object.

Class ListObjectChildrenResponse

This is the response object from the ListObjectChildren operation.

Class ListObjectParentPathsRequest

Container for the parameters to the ListObjectParentPaths operation. 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.

Class ListObjectParentPathsResponse

This is the response object from the ListObjectParentPaths operation.

Class ListObjectParentsRequest

Container for the parameters to the ListObjectParents operation. Lists parent objects that are associated with a given object in pagination fashion.

Class ListObjectParentsResponse

This is the response object from the ListObjectParents operation.

Class ListObjectPoliciesRequest

Container for the parameters to the ListObjectPolicies operation. Returns policies attached to an object in pagination fashion.

Class ListObjectPoliciesResponse

This is the response object from the ListObjectPolicies operation.

Class ListOutgoingTypedLinksRequest

Container for the parameters to the ListOutgoingTypedLinks operation. 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.

Class ListOutgoingTypedLinksResponse

This is the response object from the ListOutgoingTypedLinks operation.

Class ListPolicyAttachmentsRequest

Container for the parameters to the ListPolicyAttachments operation. Returns all of the ObjectIdentifiers to which a given policy is attached.

Class ListPolicyAttachmentsResponse

This is the response object from the ListPolicyAttachments operation.

Class ListPublishedSchemaArnsRequest

Container for the parameters to the ListPublishedSchemaArns operation. 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.

Class ListPublishedSchemaArnsResponse

This is the response object from the ListPublishedSchemaArns operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. 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.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListTypedLinkFacetAttributesRequest

Container for the parameters to the ListTypedLinkFacetAttributes operation. Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

Class ListTypedLinkFacetAttributesResponse

This is the response object from the ListTypedLinkFacetAttributes operation.

Class ListTypedLinkFacetNamesRequest

Container for the parameters to the ListTypedLinkFacetNames operation. Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links.

Class ListTypedLinkFacetNamesResponse

This is the response object from the ListTypedLinkFacetNames operation.

Class LookupPolicyRequest

Container for the parameters to the LookupPolicy operation. 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.

Class LookupPolicyResponse

This is the response object from the LookupPolicy operation.

Class NotIndexException

Indicates that the requested operation can only operate on index objects.

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

Class NotPolicyException

Indicates that the requested operation can only operate on policy objects.

Class ObjectAlreadyDetachedException

Indicates that the object is not attached to the index.

Class ObjectAttributeAction

The action to take on the object attribute.

Class ObjectAttributeRange

A range of attributes.

Class ObjectAttributeUpdate

Structure that contains attribute update information.

Class ObjectIdentifierAndLinkNameTuple

A pair of ObjectIdentifier and LinkName.

Class ObjectNotDetachedException

Indicates that the requested operation cannot be completed because the object has not been detached from the tree.

Class ObjectReference

The reference that identifies an object.

Class PathToObjectIdentifiers

Returns the path to the ObjectIdentifiers that is associated with the directory.

Class PolicyAttachment

Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached. For more information, see Policies.

Class PolicyToPath

Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.

Class PublishSchemaRequest

Container for the parameters to the PublishSchema operation. Publishes a development schema with a major version and a recommended minor version.

Class PublishSchemaResponse

This is the response object from the PublishSchema operation.

Class PutSchemaFromJsonRequest

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

Class PutSchemaFromJsonResponse

This is the response object from the PutSchemaFromJson operation.

Class RemoveFacetFromObjectRequest

Container for the parameters to the RemoveFacetFromObject operation. Removes the specified facet from the specified object.

Class RemoveFacetFromObjectResponse

This is the response object from the RemoveFacetFromObject operation.

Class ResourceNotFoundException

The specified resource could not be found.

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

Class Rule

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

Class SchemaAlreadyExistsException

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

Class SchemaAlreadyPublishedException

Indicates that a schema is already published.

Class SchemaFacet

A facet.

Class StillContainsLinksException

The object could not be deleted because links still exist. Remove the links and then try the operation again.

Class Tag

The tag structure that contains a tag key and value.

Class TagResourceRequest

Container for the parameters to the TagResource operation. An API operation for adding tags to a resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TypedAttributeValue

Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.

Class TypedAttributeValueRange

A range of attribute values. For more information, see Range Filters.

Class TypedLinkAttributeDefinition

A typed link attribute definition.

Class TypedLinkAttributeRange

Identifies the range of attributes that are used by a specified filter.

Class TypedLinkFacet

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

Class TypedLinkFacetAttributeUpdate

A typed link facet attribute update.

Class TypedLinkSchemaAndFacetName

Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

Class TypedLinkSpecifier

Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

Class UnsupportedIndexTypeException

Indicates that the requested index type is not supported.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. An API operation for removing tags from a resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateFacetRequest

Container for the parameters to the UpdateFacet operation. Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

Class UpdateFacetResponse

This is the response object from the UpdateFacet operation.

Class UpdateLinkAttributesRequest

Container for the parameters to the UpdateLinkAttributes operation. 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.

Class UpdateLinkAttributesResponse

This is the response object from the UpdateLinkAttributes operation.

Class UpdateObjectAttributesRequest

Container for the parameters to the UpdateObjectAttributes operation. Updates a given object's attributes.

Class UpdateObjectAttributesResponse

This is the response object from the UpdateObjectAttributes operation.

Class UpdateSchemaRequest

Container for the parameters to the UpdateSchema operation. Updates the schema name with a new name. Only development schema names can be updated.

Class UpdateSchemaResponse

This is the response object from the UpdateSchema operation.

Class UpdateTypedLinkFacetRequest

Container for the parameters to the UpdateTypedLinkFacet operation. Updates a TypedLinkFacet. For more information, see Typed Links.

Class UpdateTypedLinkFacetResponse

This is the response object from the UpdateTypedLinkFacet operation.

Class UpgradeAppliedSchemaRequest

Container for the parameters to the UpgradeAppliedSchema operation. 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.

Class UpgradeAppliedSchemaResponse

This is the response object from the UpgradeAppliedSchema operation.

Class UpgradePublishedSchemaRequest

Container for the parameters to the UpgradePublishedSchema operation. Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

Class UpgradePublishedSchemaResponse

This is the response object from the UpgradePublishedSchema operation.

Class ValidationException

Indicates that your request is malformed in some manner. See the exception message.

Interfaces

NameDescription
Interface ICloudDirectoryPaginatorFactory

Paginators for the CloudDirectory service

Interface IListAppliedSchemaArnsPaginator

Paginator for the ListAppliedSchemaArns operation

Interface IListAttachedIndicesPaginator

Paginator for the ListAttachedIndices operation

Interface IListDevelopmentSchemaArnsPaginator

Paginator for the ListDevelopmentSchemaArns operation

Interface IListDirectoriesPaginator

Paginator for the ListDirectories operation

Interface IListFacetAttributesPaginator

Paginator for the ListFacetAttributes operation

Interface IListFacetNamesPaginator

Paginator for the ListFacetNames operation

Interface IListIndexPaginator

Paginator for the ListIndex operation

Interface IListManagedSchemaArnsPaginator

Paginator for the ListManagedSchemaArns operation

Interface IListObjectAttributesPaginator

Paginator for the ListObjectAttributes operation

Interface IListObjectChildrenPaginator

Paginator for the ListObjectChildren operation

Interface IListObjectParentPathsPaginator

Paginator for the ListObjectParentPaths operation

Interface IListObjectParentsPaginator

Paginator for the ListObjectParents operation

Interface IListObjectPoliciesPaginator

Paginator for the ListObjectPolicies operation

Interface IListPolicyAttachmentsPaginator

Paginator for the ListPolicyAttachments operation

Interface IListPublishedSchemaArnsPaginator

Paginator for the ListPublishedSchemaArns operation

Interface IListTagsForResourcePaginator

Paginator for the ListTagsForResource operation

Interface IListTypedLinkFacetAttributesPaginator

Paginator for the ListTypedLinkFacetAttributes operation

Interface IListTypedLinkFacetNamesPaginator

Paginator for the ListTypedLinkFacetNames operation

Interface ILookupPolicyPaginator

Paginator for the LookupPolicy operation