logo
Expand description

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.

If you’re using the service, you’re probably looking for CloudDirectoryClient and CloudDirectory.

Structs

A unique identifier for an attribute.

The combination of an attribute key and an attribute value.

Identifies the attribute name and value for a typed link.

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

The result of a batch add facet to object operation.

Represents the output of an AttachObject operation.

Represents the output batch AttachObject response operation.

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

Represents the output of an AttachPolicy response operation.

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

Represents the output of a AttachToIndex response operation.

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

Represents the output of a AttachTypedLink response operation.

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

Represents the output of a CreateIndex response operation.

Represents the output of a CreateObject operation.

Represents the output of a CreateObject response operation.

Represents the output of a DeleteObject operation.

Represents the output of a DeleteObject response operation.

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

Represents the output of a DetachFromIndex response operation.

Represents the output of a DetachObject operation.

Represents the output of a DetachObject response operation.

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

Represents the output of a DetachPolicy response operation.

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

Represents the output of a DetachTypedLink response operation.

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

Represents the output of a GetLinkAttributes response operation.

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

Represents the output of a GetObjectAttributes response operation.

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

Represents the output of a GetObjectInformation response operation.

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

Represents the output of a ListAttachedIndices response operation.

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.

Represents the output of a ListIncomingTypedLinks response operation.

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

Represents the output of a ListIndex response operation.

Represents the output of a ListObjectAttributes operation.

Represents the output of a ListObjectAttributes response operation.

Represents the output of a ListObjectChildren operation.

Represents the output of a ListObjectChildren response operation.

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.

Represents the output of a ListObjectParentPaths response operation.

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

Represents the output of a ListObjectPolicies response operation.

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.

Represents the output of a ListOutgoingTypedLinks response operation.

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

Represents the output of a ListPolicyAttachments response operation.

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.

Represents the output of a LookupPolicy response operation.

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

Represents the output of a BatchRead operation.

Represents the output of a BatchRead response operation.

Represents the output of a BatchRead success response operation.

A batch operation to remove a facet from an object.

An empty result that represents success.

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.

Represents the output of a UpdateLinkAttributes response operation.

Represents the output of a BatchUpdate operation.

Represents the output of a BatchUpdate response operation.

Represents the output of a BatchWrite operation.

Represents the output of a BatchWrite response operation.

A client for the Amazon CloudDirectory API.

Directory structure that includes the directory name and directory ARN.

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

An attribute that is associated with the Facet.

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

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

A structure that contains information used to update an attribute.

Represents an index and an attached object.

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

Structure that contains attribute update information.

The action to take on the object attribute.

A range of attributes.

Structure that contains attribute update information.

A pair of ObjectIdentifier and LinkName.

The reference that identifies an object.

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

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

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.

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

A facet.

The tag structure that contains a tag key and value.

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.

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

A typed link attribute definition.

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

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

A typed link facet attribute update.

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

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.

Enums

Errors returned by AddFacetToObject

Errors returned by ApplySchema

Errors returned by AttachObject

Errors returned by AttachPolicy

Errors returned by AttachToIndex

Errors returned by AttachTypedLink

Errors returned by BatchRead

Errors returned by BatchWrite

Errors returned by CreateDirectory

Errors returned by CreateFacet

Errors returned by CreateIndex

Errors returned by CreateObject

Errors returned by CreateSchema

Errors returned by CreateTypedLinkFacet

Errors returned by DeleteDirectory

Errors returned by DeleteFacet

Errors returned by DeleteObject

Errors returned by DeleteSchema

Errors returned by DeleteTypedLinkFacet

Errors returned by DetachFromIndex

Errors returned by DetachObject

Errors returned by DetachPolicy

Errors returned by DetachTypedLink

Errors returned by DisableDirectory

Errors returned by EnableDirectory

Errors returned by GetAppliedSchemaVersion

Errors returned by GetDirectory

Errors returned by GetFacet

Errors returned by GetLinkAttributes

Errors returned by GetObjectAttributes

Errors returned by GetObjectInformation

Errors returned by GetSchemaAsJson

Errors returned by GetTypedLinkFacetInformation

Errors returned by ListAppliedSchemaArns

Errors returned by ListAttachedIndices

Errors returned by ListDevelopmentSchemaArns

Errors returned by ListDirectories

Errors returned by ListFacetAttributes

Errors returned by ListFacetNames

Errors returned by ListIncomingTypedLinks

Errors returned by ListIndex

Errors returned by ListManagedSchemaArns

Errors returned by ListObjectAttributes

Errors returned by ListObjectChildren

Errors returned by ListObjectParentPaths

Errors returned by ListObjectParents

Errors returned by ListObjectPolicies

Errors returned by ListOutgoingTypedLinks

Errors returned by ListPolicyAttachments

Errors returned by ListPublishedSchemaArns

Errors returned by ListTagsForResource

Errors returned by ListTypedLinkFacetAttributes

Errors returned by ListTypedLinkFacetNames

Errors returned by LookupPolicy

Errors returned by PublishSchema

Errors returned by PutSchemaFromJson

Errors returned by RemoveFacetFromObject

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateFacet

Errors returned by UpdateLinkAttributes

Errors returned by UpdateObjectAttributes

Errors returned by UpdateSchema

Errors returned by UpdateTypedLinkFacet

Errors returned by UpgradeAppliedSchema

Errors returned by UpgradePublishedSchema

Traits

Trait representing the capabilities of the Amazon CloudDirectory API. Amazon CloudDirectory clients implement this trait.