amazonaws.com – clouddirectory

Tools (67)

Extracted live via the executor SDK.

• amazonclouddirectory.addFacetToObject

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

• amazonclouddirectory.applySchema

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

• amazonclouddirectory.attachObject

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

  1. Using the path

  2. Using ObjectIdentifier

• amazonclouddirectory.attachPolicy

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

• amazonclouddirectory.attachToIndex

  Attaches the specified object to the specified index.

• amazonclouddirectory.attachTypedLink

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

• amazonclouddirectory.batchRead

  Performs all the read operations in a batch.

• amazonclouddirectory.batchWrite

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

• amazonclouddirectory.createDirectory

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

• amazonclouddirectory.createFacet

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

• amazonclouddirectory.createIndex

  Creates an index object. See Indexing for more information.

• amazonclouddirectory.createObject

  Creates an object in a Directory [blocked]. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet [blocked] 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.

• amazonclouddirectory.createSchema

  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.

• amazonclouddirectory.createTypedLinkFacet

  Creates a TypedLinkFacet [blocked]. For more information, see Typed link.

• amazonclouddirectory.deleteDirectory

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

• amazonclouddirectory.deleteFacet

  Deletes a given Facet [blocked]. All attributes and Rule [blocked]s that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

• amazonclouddirectory.deleteObject

  Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

• amazonclouddirectory.deleteSchema

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

• amazonclouddirectory.deleteTypedLinkFacet

  Deletes a TypedLinkFacet [blocked]. For more information, see Typed link.

• amazonclouddirectory.detachFromIndex

  Detaches the specified object from the specified index.

• amazonclouddirectory.detachObject

  Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

• amazonclouddirectory.detachPolicy

  Detaches a policy from an object.

• amazonclouddirectory.detachTypedLink

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

• amazonclouddirectory.disableDirectory

  Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

• amazonclouddirectory.enableDirectory

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

• amazonclouddirectory.getAppliedSchemaVersion

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

• amazonclouddirectory.getDirectory

  Retrieves metadata about a directory.

• amazonclouddirectory.getFacet

  Gets details of the Facet [blocked], such as facet name, attributes, Rule [blocked]s, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

• amazonclouddirectory.getLinkAttributes

  Retrieves attributes that are associated with a typed link.

• amazonclouddirectory.getObjectAttributes

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

• amazonclouddirectory.getObjectInformation

  Retrieves metadata about an object.

• amazonclouddirectory.getSchemaAsJson

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

• amazonclouddirectory.getTypedLinkFacetInformation

  Returns the identity attribute order for a specific TypedLinkFacet [blocked]. For more information, see Typed link.

• amazonclouddirectory.listAppliedSchemaArns

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

• amazonclouddirectory.listAttachedIndices

  Lists indices attached to the specified object.

• amazonclouddirectory.listDevelopmentSchemaArns

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

• amazonclouddirectory.listDirectories

  Lists directories created within an account.

• amazonclouddirectory.listFacetAttributes

  Retrieves attributes attached to the facet.

• amazonclouddirectory.listFacetNames

  Retrieves the names of facets that exist in a schema.

• amazonclouddirectory.listIncomingTypedLinks

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

• amazonclouddirectory.listIndex

  Lists objects attached to the specified index.

• amazonclouddirectory.listObjectAttributes

  Lists all attributes that are associated with an object.

• amazonclouddirectory.listObjectChildren

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

• amazonclouddirectory.listObjectParentPaths

  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.

• amazonclouddirectory.listObjectParents

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

• amazonclouddirectory.listObjectPolicies

  Returns policies attached to an object in pagination fashion.

• amazonclouddirectory.listOutgoingTypedLinks

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

• amazonclouddirectory.listPolicyAttachments

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

• amazonclouddirectory.listPublishedSchemaArns

  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.

• amazonclouddirectory.listTagsForResource

  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.

• amazonclouddirectory.listTypedLinkFacetAttributes

  Returns a paginated list of all attribute definitions for a particular TypedLinkFacet [blocked]. For more information, see Typed link.

• amazonclouddirectory.listTypedLinkFacetNames

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

• amazonclouddirectory.lookupPolicy

  Lists all policies from the root of the Directory [blocked] 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.

• amazonclouddirectory.publishSchema

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

• amazonclouddirectory.putSchemaFromJson

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

• amazonclouddirectory.removeFacetFromObject

  Removes the specified facet from the specified object.

• amazonclouddirectory.tagResource

  An API operation for adding tags to a resource.

• amazonclouddirectory.untagResource

  An API operation for removing tags from a resource.

• amazonclouddirectory.updateFacet

  Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

• amazonclouddirectory.updateLinkAttributes

  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.

• amazonclouddirectory.updateObjectAttributes

  Updates a given object's attributes.

• amazonclouddirectory.updateSchema

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

• amazonclouddirectory.updateTypedLinkFacet

  Updates a TypedLinkFacet [blocked]. For more information, see Typed link.

• amazonclouddirectory.upgradeAppliedSchema

  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.

• amazonclouddirectory.upgradePublishedSchema

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

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools