Expand description
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§
- AddFacet
ToObject Request - AddFacet
ToObject Response - Apply
Schema Request - Apply
Schema Response - Attach
Object Request - Attach
Object Response - Attach
Policy Request - Attach
Policy Response - Attach
ToIndex Request - Attach
ToIndex Response - Attach
Typed Link Request - Attach
Typed Link Response - Attribute
Key A unique identifier for an attribute.
- Attribute
KeyAnd Value The combination of an attribute key and an attribute value.
- Attribute
Name AndValue Identifies the attribute name and value for a typed link.
- Batch
AddFacet ToObject Represents the output of a batch add facet to object operation.
- Batch
AddFacet ToObject Response The result of a batch add facet to object operation.
- Batch
Attach Object Represents the output of an AttachObject operation.
- Batch
Attach Object Response Represents the output batch AttachObject response operation.
- Batch
Attach Policy Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.
- Batch
Attach Policy Response Represents the output of an AttachPolicy response operation.
- Batch
Attach ToIndex Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.
- Batch
Attach ToIndex Response Represents the output of a AttachToIndex response operation.
- Batch
Attach Typed Link Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.
- Batch
Attach Typed Link Response Represents the output of a AttachTypedLink response operation.
- Batch
Create Index Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.
- Batch
Create Index Response Represents the output of a CreateIndex response operation.
- Batch
Create Object Represents the output of a CreateObject operation.
- Batch
Create Object Response Represents the output of a CreateObject response operation.
- Batch
Delete Object Represents the output of a DeleteObject operation.
- Batch
Delete Object Response Represents the output of a DeleteObject response operation.
- Batch
Detach From Index Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.
- Batch
Detach From Index Response Represents the output of a DetachFromIndex response operation.
- Batch
Detach Object Represents the output of a DetachObject operation.
- Batch
Detach Object Response Represents the output of a DetachObject response operation.
- Batch
Detach Policy Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.
- Batch
Detach Policy Response Represents the output of a DetachPolicy response operation.
- Batch
Detach Typed Link Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.
- Batch
Detach Typed Link Response Represents the output of a DetachTypedLink response operation.
- Batch
GetLink Attributes Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.
- Batch
GetLink Attributes Response Represents the output of a GetLinkAttributes response operation.
- Batch
GetObject Attributes Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations.
- Batch
GetObject Attributes Response Represents the output of a GetObjectAttributes response operation.
- Batch
GetObject Information Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.
- Batch
GetObject Information Response Represents the output of a GetObjectInformation response operation.
- Batch
List Attached Indices Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.
- Batch
List Attached Indices Response Represents the output of a ListAttachedIndices response operation.
- Batch
List Incoming Typed Links 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.
- Batch
List Incoming Typed Links Response Represents the output of a ListIncomingTypedLinks response operation.
- Batch
List Index Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.
- Batch
List Index Response Represents the output of a ListIndex response operation.
- Batch
List Object Attributes Represents the output of a ListObjectAttributes operation.
- Batch
List Object Attributes Response Represents the output of a ListObjectAttributes response operation.
- Batch
List Object Children Represents the output of a ListObjectChildren operation.
- Batch
List Object Children Response Represents the output of a ListObjectChildren response operation.
- Batch
List Object Parent Paths 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.
- Batch
List Object Parent Paths Response Represents the output of a ListObjectParentPaths response operation.
- Batch
List Object Parents - Batch
List Object Parents Response - Batch
List Object Policies Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.
- Batch
List Object Policies Response Represents the output of a ListObjectPolicies response operation.
- Batch
List Outgoing Typed Links 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.
- Batch
List Outgoing Typed Links Response Represents the output of a ListOutgoingTypedLinks response operation.
- Batch
List Policy Attachments Returns all of the
ObjectIdentifiersto which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.- Batch
List Policy Attachments Response Represents the output of a ListPolicyAttachments response operation.
- Batch
Lookup Policy 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.
- Batch
Lookup Policy Response Represents the output of a LookupPolicy response operation.
- Batch
Read Exception The batch read exception structure, which contains the exception type and message.
- Batch
Read Operation Represents the output of a
BatchReadoperation.- Batch
Read Operation Response Represents the output of a
BatchReadresponse operation.- Batch
Read Request - Batch
Read Response - Batch
Read Successful Response Represents the output of a
BatchReadsuccess response operation.- Batch
Remove Facet From Object A batch operation to remove a facet from an object.
- Batch
Remove Facet From Object Response An empty result that represents success.
- Batch
Update Link Attributes 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.- Batch
Update Link Attributes Response Represents the output of a UpdateLinkAttributes response operation.
- Batch
Update Object Attributes Represents the output of a
BatchUpdateoperation.- Batch
Update Object Attributes Response Represents the output of a
BatchUpdateresponse operation.- Batch
Write Operation Represents the output of a
BatchWriteoperation.- Batch
Write Operation Response Represents the output of a
BatchWriteresponse operation.- Batch
Write Request - Batch
Write Response - Cloud
Directory Client - A client for the Amazon CloudDirectory API.
- Create
Directory Request - Create
Directory Response - Create
Facet Request - Create
Facet Response - Create
Index Request - Create
Index Response - Create
Object Request - Create
Object Response - Create
Schema Request - Create
Schema Response - Create
Typed Link Facet Request - Create
Typed Link Facet Response - Delete
Directory Request - Delete
Directory Response - Delete
Facet Request - Delete
Facet Response - Delete
Object Request - Delete
Object Response - Delete
Schema Request - Delete
Schema Response - Delete
Typed Link Facet Request - Delete
Typed Link Facet Response - Detach
From Index Request - Detach
From Index Response - Detach
Object Request - Detach
Object Response - Detach
Policy Request - Detach
Policy Response - Detach
Typed Link Request - Directory
Directory structure that includes the directory name and directory ARN.
- Disable
Directory Request - Disable
Directory Response - Enable
Directory Request - Enable
Directory Response - Facet
A structure that contains
Name,ARN,Attributes,Rules, andObjectTypes. See Facets for more information.- Facet
Attribute An attribute that is associated with the Facet.
- Facet
Attribute Definition A facet attribute definition. See Attribute References for more information.
- Facet
Attribute Reference The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.
- Facet
Attribute Update A structure that contains information used to update an attribute.
- GetApplied
Schema Version Request - GetApplied
Schema Version Response - GetDirectory
Request - GetDirectory
Response - GetFacet
Request - GetFacet
Response - GetLink
Attributes Request - GetLink
Attributes Response - GetObject
Attributes Request - GetObject
Attributes Response - GetObject
Information Request - GetObject
Information Response - GetSchema
AsJson Request - GetSchema
AsJson Response - GetTyped
Link Facet Information Request - GetTyped
Link Facet Information Response - Index
Attachment Represents an index and an attached object.
- Link
Attribute Action The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.
- Link
Attribute Update Structure that contains attribute update information.
- List
Applied Schema Arns Request - List
Applied Schema Arns Response - List
Attached Indices Request - List
Attached Indices Response - List
Development Schema Arns Request - List
Development Schema Arns Response - List
Directories Request - List
Directories Response - List
Facet Attributes Request - List
Facet Attributes Response - List
Facet Names Request - List
Facet Names Response - List
Incoming Typed Links Request - List
Incoming Typed Links Response - List
Index Request - List
Index Response - List
Managed Schema Arns Request - List
Managed Schema Arns Response - List
Object Attributes Request - List
Object Attributes Response - List
Object Children Request - List
Object Children Response - List
Object Parent Paths Request - List
Object Parent Paths Response - List
Object Parents Request - List
Object Parents Response - List
Object Policies Request - List
Object Policies Response - List
Outgoing Typed Links Request - List
Outgoing Typed Links Response - List
Policy Attachments Request - List
Policy Attachments Response - List
Published Schema Arns Request - List
Published Schema Arns Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Typed Link Facet Attributes Request - List
Typed Link Facet Attributes Response - List
Typed Link Facet Names Request - List
Typed Link Facet Names Response - Lookup
Policy Request - Lookup
Policy Response - Object
Attribute Action The action to take on the object attribute.
- Object
Attribute Range A range of attributes.
- Object
Attribute Update Structure that contains attribute update information.
- Object
Identifier AndLink Name Tuple A pair of ObjectIdentifier and LinkName.
- Object
Reference The reference that identifies an object.
- Path
ToObject Identifiers Returns the path to the
ObjectIdentifiersthat is associated with the directory.- Policy
Attachment Contains the
PolicyType,PolicyId, and theObjectIdentifierto which it is attached. For more information, see Policies.- Policy
ToPath 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.
- Publish
Schema Request - Publish
Schema Response - PutSchema
From Json Request - PutSchema
From Json Response - Remove
Facet From Object Request - Remove
Facet From Object Response - Rule
Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
- Schema
Facet A facet.
- Tag
The tag structure that contains a tag key and value.
- TagResource
Request - TagResource
Response - Typed
Attribute 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.
- Typed
Attribute Value Range A range of attribute values. For more information, see Range Filters.
- Typed
Link Attribute Definition A typed link attribute definition.
- Typed
Link Attribute Range Identifies the range of attributes that are used by a specified filter.
- Typed
Link Facet Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.
- Typed
Link Facet Attribute Update A typed link facet attribute update.
- Typed
Link Schema AndFacet Name Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.
- Typed
Link Specifier 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.
- Untag
Resource Request - Untag
Resource Response - Update
Facet Request - Update
Facet Response - Update
Link Attributes Request - Update
Link Attributes Response - Update
Object Attributes Request - Update
Object Attributes Response - Update
Schema Request - Update
Schema Response - Update
Typed Link Facet Request - Update
Typed Link Facet Response - Upgrade
Applied Schema Request - Upgrade
Applied Schema Response - Upgrade
Published Schema Request - Upgrade
Published Schema Response
Enums§
- AddFacet
ToObject Error - Errors returned by AddFacetToObject
- Apply
Schema Error - Errors returned by ApplySchema
- Attach
Object Error - Errors returned by AttachObject
- Attach
Policy Error - Errors returned by AttachPolicy
- Attach
ToIndex Error - Errors returned by AttachToIndex
- Attach
Typed Link Error - Errors returned by AttachTypedLink
- Batch
Read Error - Errors returned by BatchRead
- Batch
Write Error - Errors returned by BatchWrite
- Create
Directory Error - Errors returned by CreateDirectory
- Create
Facet Error - Errors returned by CreateFacet
- Create
Index Error - Errors returned by CreateIndex
- Create
Object Error - Errors returned by CreateObject
- Create
Schema Error - Errors returned by CreateSchema
- Create
Typed Link Facet Error - Errors returned by CreateTypedLinkFacet
- Delete
Directory Error - Errors returned by DeleteDirectory
- Delete
Facet Error - Errors returned by DeleteFacet
- Delete
Object Error - Errors returned by DeleteObject
- Delete
Schema Error - Errors returned by DeleteSchema
- Delete
Typed Link Facet Error - Errors returned by DeleteTypedLinkFacet
- Detach
From Index Error - Errors returned by DetachFromIndex
- Detach
Object Error - Errors returned by DetachObject
- Detach
Policy Error - Errors returned by DetachPolicy
- Detach
Typed Link Error - Errors returned by DetachTypedLink
- Disable
Directory Error - Errors returned by DisableDirectory
- Enable
Directory Error - Errors returned by EnableDirectory
- GetApplied
Schema Version Error - Errors returned by GetAppliedSchemaVersion
- GetDirectory
Error - Errors returned by GetDirectory
- GetFacet
Error - Errors returned by GetFacet
- GetLink
Attributes Error - Errors returned by GetLinkAttributes
- GetObject
Attributes Error - Errors returned by GetObjectAttributes
- GetObject
Information Error - Errors returned by GetObjectInformation
- GetSchema
AsJson Error - Errors returned by GetSchemaAsJson
- GetTyped
Link Facet Information Error - Errors returned by GetTypedLinkFacetInformation
- List
Applied Schema Arns Error - Errors returned by ListAppliedSchemaArns
- List
Attached Indices Error - Errors returned by ListAttachedIndices
- List
Development Schema Arns Error - Errors returned by ListDevelopmentSchemaArns
- List
Directories Error - Errors returned by ListDirectories
- List
Facet Attributes Error - Errors returned by ListFacetAttributes
- List
Facet Names Error - Errors returned by ListFacetNames
- List
Incoming Typed Links Error - Errors returned by ListIncomingTypedLinks
- List
Index Error - Errors returned by ListIndex
- List
Managed Schema Arns Error - Errors returned by ListManagedSchemaArns
- List
Object Attributes Error - Errors returned by ListObjectAttributes
- List
Object Children Error - Errors returned by ListObjectChildren
- List
Object Parent Paths Error - Errors returned by ListObjectParentPaths
- List
Object Parents Error - Errors returned by ListObjectParents
- List
Object Policies Error - Errors returned by ListObjectPolicies
- List
Outgoing Typed Links Error - Errors returned by ListOutgoingTypedLinks
- List
Policy Attachments Error - Errors returned by ListPolicyAttachments
- List
Published Schema Arns Error - Errors returned by ListPublishedSchemaArns
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Typed Link Facet Attributes Error - Errors returned by ListTypedLinkFacetAttributes
- List
Typed Link Facet Names Error - Errors returned by ListTypedLinkFacetNames
- Lookup
Policy Error - Errors returned by LookupPolicy
- Publish
Schema Error - Errors returned by PublishSchema
- PutSchema
From Json Error - Errors returned by PutSchemaFromJson
- Remove
Facet From Object Error - Errors returned by RemoveFacetFromObject
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Facet Error - Errors returned by UpdateFacet
- Update
Link Attributes Error - Errors returned by UpdateLinkAttributes
- Update
Object Attributes Error - Errors returned by UpdateObjectAttributes
- Update
Schema Error - Errors returned by UpdateSchema
- Update
Typed Link Facet Error - Errors returned by UpdateTypedLinkFacet
- Upgrade
Applied Schema Error - Errors returned by UpgradeAppliedSchema
- Upgrade
Published Schema Error - Errors returned by UpgradePublishedSchema
Traits§
- Cloud
Directory - Trait representing the capabilities of the Amazon CloudDirectory API. Amazon CloudDirectory clients implement this trait.