Amazon Web Services, Inc.

Amazon 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,…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .
Amazon Cloud Directory is no longer open to new customers and will reach end of support on July 24, 2027. For alternatives to Amazon Cloud Directory, explore Amazon DynamoDB and Amazon Neptune . If you need help choosing the right alternative for your use case, or for any other questions, contact AWS Support .

Endpoints 66

  • PUTAdd facet to object/amazonclouddirectory/2017-01-11/object/facetsAdds a new Facet to an object. An object can have more than one facet applied on it.
  • PUTApply schema/amazonclouddirectory/2017-01-11/schema/applyCopies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
  • PUTAttach object/amazonclouddirectory/2017-01-11/object/attachAttaches an existing object to another object. An object can be accessed in two ways: Using the path Using ObjectIdentifier
  • PUTAttach policy/amazonclouddirectory/2017-01-11/policy/attachAttaches a policy object to a regular object. An object can have a limited number of attached policies.
  • PUTAttach to index/amazonclouddirectory/2017-01-11/index/attachAttaches the specified object to the specified index.
  • PUTAttach typed link/amazonclouddirectory/2017-01-11/typedlink/attachAttaches a typed link to a specified source and target object. For more information, see Typed Links .
  • POSTBatch read/amazonclouddirectory/2017-01-11/batchreadPerforms all the read operations in a batch.
  • PUTBatch write/amazonclouddirectory/2017-01-11/batchwritePerforms all the write operations in a batch. Either all the operations succeed or none.
  • PUTCreate directory/amazonclouddirectory/2017-01-11/directory/createCreates a Directory by copying the published schema into the directory. A directory cannot be created without a schema. You can also quickly create a…
  • PUTCreate facet/amazonclouddirectory/2017-01-11/facet/createCreates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
  • PUTCreate index/amazonclouddirectory/2017-01-11/indexCreates an index object. See Indexing and search for more information.
  • PUTCreate object/amazonclouddirectory/2017-01-11/objectCreates 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…
  • PUTCreate schema/amazonclouddirectory/2017-01-11/schema/createCreates 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…
  • PUTCreate typed link facet/amazonclouddirectory/2017-01-11/typedlink/facet/createCreates a TypedLinkFacet . For more information, see Typed Links .
  • PUTDelete directory/amazonclouddirectory/2017-01-11/directoryDeletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
  • PUTDelete facet/amazonclouddirectory/2017-01-11/facet/deleteDeletes a given Facet . All attributes and Rule s that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
  • PUTDelete object/amazonclouddirectory/2017-01-11/object/deleteDeletes 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…
  • PUTDelete schema/amazonclouddirectory/2017-01-11/schemaDeletes a given schema. Schemas in a development and published state can only be deleted.
  • PUTDelete typed link facet/amazonclouddirectory/2017-01-11/typedlink/facet/deleteDeletes a TypedLinkFacet . For more information, see Typed Links .
  • PUTDetach from index/amazonclouddirectory/2017-01-11/index/detachDetaches the specified object from the specified index.
  • PUTDetach object/amazonclouddirectory/2017-01-11/object/detachDetaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
  • PUTDetach policy/amazonclouddirectory/2017-01-11/policy/detachDetaches a policy from an object.
  • PUTDetach typed link/amazonclouddirectory/2017-01-11/typedlink/detachDetaches a typed link from a specified source and target object. For more information, see Typed Links .
  • PUTDisable directory/amazonclouddirectory/2017-01-11/directory/disableDisables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be…
  • PUTEnable directory/amazonclouddirectory/2017-01-11/directory/enableEnables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
  • POSTGet applied schema version/amazonclouddirectory/2017-01-11/schema/getappliedschemaReturns current applied schema version ARN, including the minor version in use.
  • POSTGet directory/amazonclouddirectory/2017-01-11/directory/getRetrieves metadata about a directory.
  • PUTUpdate facet/amazonclouddirectory/2017-01-11/facetDoes the following: Adds new Attributes , Rules , or ObjectTypes . Updates existing Attributes , Rules , or ObjectTypes . Deletes existing Attributes , Rules…
  • POSTGet facet/amazonclouddirectory/2017-01-11/facetGets details of the Facet , such as facet name, attributes, Rule s, or ObjectType . You can call this on all kinds of schema facets -- published, development,…
  • POSTGet link attributes/amazonclouddirectory/2017-01-11/typedlink/attributes/getRetrieves attributes that are associated with a typed link.
  • POSTGet object attributes/amazonclouddirectory/2017-01-11/object/attributes/getRetrieves attributes within a facet that are associated with an object.
  • POSTGet object information/amazonclouddirectory/2017-01-11/object/informationRetrieves metadata about an object.
  • PUTPut schema from json/amazonclouddirectory/2017-01-11/schema/jsonAllows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
  • POSTGet schema as json/amazonclouddirectory/2017-01-11/schema/jsonRetrieves a JSON representation of the schema. See JSON Schema Format for more information.
  • POSTGet typed link facet information/amazonclouddirectory/2017-01-11/typedlink/facet/getReturns the identity attribute order for a specific TypedLinkFacet . For more information, see Typed Links .
  • POSTList applied schema arns/amazonclouddirectory/2017-01-11/schema/appliedLists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.
  • POSTList attached indices/amazonclouddirectory/2017-01-11/object/indicesLists indices attached to the specified object.
  • POSTList development schema arns/amazonclouddirectory/2017-01-11/schema/developmentRetrieves each Amazon Resource Name (ARN) of schemas in the development state.
  • POSTList directories/amazonclouddirectory/2017-01-11/directory/listLists directories created within an account.
  • POSTList facet attributes/amazonclouddirectory/2017-01-11/facet/attributesRetrieves attributes attached to the facet.
  • POSTList facet names/amazonclouddirectory/2017-01-11/facet/listRetrieves the names of facets that exist in a schema.
  • POSTList incoming typed links/amazonclouddirectory/2017-01-11/typedlink/incomingReturns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity…
  • POSTList index/amazonclouddirectory/2017-01-11/index/targetsLists objects attached to the specified index.
  • POSTList managed schema arns/amazonclouddirectory/2017-01-11/schema/managedLists 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…
  • POSTList object attributes/amazonclouddirectory/2017-01-11/object/attributesLists all attributes that are associated with an object.
  • POSTList object children/amazonclouddirectory/2017-01-11/object/childrenReturns a paginated list of child objects that are associated with a given object.
  • POSTList object parent paths/amazonclouddirectory/2017-01-11/object/parentpathsRetrieves 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…
  • POSTList object parents/amazonclouddirectory/2017-01-11/object/parentLists parent objects that are associated with a given object in pagination fashion.
  • POSTList object policies/amazonclouddirectory/2017-01-11/object/policyReturns policies attached to an object in pagination fashion.
  • POSTList outgoing typed links/amazonclouddirectory/2017-01-11/typedlink/outgoingReturns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity…
  • POSTList policy attachments/amazonclouddirectory/2017-01-11/policy/attachmentReturns all of the ObjectIdentifiers to which a given policy is attached.
  • POSTList published schema arns/amazonclouddirectory/2017-01-11/schema/publishedLists 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…
  • POSTList tags for resource/amazonclouddirectory/2017-01-11/tagsReturns 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…
  • POSTList typed link facet attributes/amazonclouddirectory/2017-01-11/typedlink/facet/attributesReturns a paginated list of all attribute definitions for a particular TypedLinkFacet . For more information, see Typed Links .
  • POSTList typed link facet names/amazonclouddirectory/2017-01-11/typedlink/facet/listReturns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links .
  • POSTLookup policy/amazonclouddirectory/2017-01-11/policy/lookupLists 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…
  • PUTPublish schema/amazonclouddirectory/2017-01-11/schema/publishPublishes a development schema with a major version and a recommended minor version.
  • PUTRemove facet from object/amazonclouddirectory/2017-01-11/object/facets/deleteRemoves the specified facet from the specified object.
  • PUTTag resource/amazonclouddirectory/2017-01-11/tags/addAn API operation for adding tags to a resource.
  • PUTUntag resource/amazonclouddirectory/2017-01-11/tags/removeAn API operation for removing tags from a resource.
  • POSTUpdate link attributes/amazonclouddirectory/2017-01-11/typedlink/attributes/updateUpdates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder .
  • PUTUpdate object attributes/amazonclouddirectory/2017-01-11/object/updateUpdates a given object's attributes.
  • PUTUpdate schema/amazonclouddirectory/2017-01-11/schema/updateUpdates the schema name with a new name. Only development schema names can be updated.
  • PUTUpdate typed link facet/amazonclouddirectory/2017-01-11/typedlink/facetUpdates a TypedLinkFacet . For more information, see Typed Links .
  • PUTUpgrade applied schema/amazonclouddirectory/2017-01-11/schema/upgradeappliedUpgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion . Backwards-compatible minor version upgrades are…
  • PUTUpgrade published schema/amazonclouddirectory/2017-01-11/schema/upgradepublishedUpgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn .

API details

Base URL
https://clouddirectory.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
66 operations on 64 pathsPUT 35POST 31
Description format
AWS Smithy model, API version 2017-01-11

How to test the Amazon CloudDirectory in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CloudDirectory collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add facet to object” (PUT /amazonclouddirectory/2017-01-11/object/facets), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon 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,… It is listed under Developer tools and has 66 endpoints.

Who publishes the Amazon CloudDirectory?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon CloudDirectory?

Requests go to https://clouddirectory.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon CloudDirectory?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon CloudDirectory have?

66 operations on 64 paths (35 PUT, 31 POST).

Is forking the Amazon CloudDirectory free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.