baiji v0.6.7 Baiji.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, 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 AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Adds a new Facet to an object

Copies the input published schema into the Directory with the same name and version as that of the published schema

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

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

Attaches the specified object to the specified index

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

Performs all the read operations in a batch

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations

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

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

Creates an index object. See Indexing for more information

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

Creates a new schema in a development state. A schema can exist in three phases

Creates a TypedLinkFacet. For more information, see Typed link

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

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

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

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

Deletes a TypedLinkFacet. For more information, see Typed link

Detaches the specified object from the specified index

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

Detaches a policy from an object

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

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

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

Retrieves metadata about a directory

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

Retrieves metadata about an object

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

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

Lists schemas applied to a directory

Lists indices attached to an object

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

Lists directories created within an account

Retrieves attributes attached to the facet

Retrieves the names of facets that exist in a schema

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 link

Lists objects attached to the specified index

Lists all attributes that are associated with an object

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

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

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

Returns policies attached to an object in pagination fashion

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 link

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

Retrieves each published schema Amazon Resource Name (ARN)

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

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

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

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

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used

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

Removes the specified facet from the specified object

An API operation for adding tags to a resource

An API operation for removing tags from a resource

Updates a given object’s attributes

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

Updates a TypedLinkFacet. For more information, see Typed link

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function add_facet_to_object(input \\ %{}, options \\ [])

Adds a new Facet to an object.

Link to this function apply_schema(input \\ %{}, options \\ [])

Copies the input published schema into the Directory with the same name and version as that of the published schema .

Link to this function attach_object(input \\ %{}, options \\ [])

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

  1. Using the path
  2. Using `ObjectIdentifier`
Link to this function attach_policy(input \\ %{}, options \\ [])

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

Link to this function attach_to_index(input \\ %{}, options \\ [])

Attaches the specified object to the specified index.

Link to this function attach_typed_link(input \\ %{}, options \\ [])

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

Link to this function batch_read(input \\ %{}, options \\ [])

Performs all the read operations in a batch.

Link to this function batch_write(input \\ %{}, options \\ [])

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.

Link to this function create_directory(input \\ %{}, options \\ [])

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

Link to this function create_facet(input \\ %{}, options \\ [])

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

Link to this function create_index(input \\ %{}, options \\ [])

Creates an index object. See Indexing for more information.

Link to this function create_object(input \\ %{}, options \\ [])

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.

Link to this function create_schema(input \\ %{}, options \\ [])

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.
Link to this function delete_directory(input \\ %{}, options \\ [])

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

Link to this function delete_facet(input \\ %{}, options \\ [])

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

Link to this function delete_object(input \\ %{}, options \\ [])

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

Link to this function delete_schema(input \\ %{}, options \\ [])

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

Link to this function detach_from_index(input \\ %{}, options \\ [])

Detaches the specified object from the specified index.

Link to this function detach_object(input \\ %{}, options \\ [])

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

Link to this function detach_policy(input \\ %{}, options \\ [])

Detaches a policy from an object.

Link to this function detach_typed_link(input \\ %{}, options \\ [])

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

Link to this function disable_directory(input \\ %{}, options \\ [])

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

Link to this function enable_directory(input \\ %{}, options \\ [])

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

Link to this function get_directory(input \\ %{}, options \\ [])

Retrieves metadata about a directory.

Link to this function get_facet(input \\ %{}, options \\ [])

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.

Link to this function get_object_information(input \\ %{}, options \\ [])

Retrieves metadata about an object.

Link to this function get_schema_as_json(input \\ %{}, options \\ [])

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

Link to this function list_applied_schema_arns(input \\ %{}, options \\ [])

Lists schemas applied to a directory.

Link to this function list_attached_indices(input \\ %{}, options \\ [])

Lists indices attached to an object.

Link to this function list_development_schema_arns(input \\ %{}, options \\ [])

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

Link to this function list_directories(input \\ %{}, options \\ [])

Lists directories created within an account.

Link to this function list_facet_attributes(input \\ %{}, options \\ [])

Retrieves attributes attached to the facet.

Link to this function list_facet_names(input \\ %{}, options \\ [])

Retrieves the names of facets that exist in a schema.

Link to this function list_incoming_typed_links(input \\ %{}, options \\ [])

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

Link to this function list_index(input \\ %{}, options \\ [])

Lists objects attached to the specified index.

Link to this function list_object_attributes(input \\ %{}, options \\ [])

Lists all attributes that are associated with an object.

Link to this function list_object_children(input \\ %{}, options \\ [])

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

Link to this function list_object_parent_paths(input \\ %{}, options \\ [])

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.

Link to this function list_object_parents(input \\ %{}, options \\ [])

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

Link to this function list_object_policies(input \\ %{}, options \\ [])

Returns policies attached to an object in pagination fashion.

Link to this function list_outgoing_typed_links(input \\ %{}, options \\ [])

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

Link to this function list_policy_attachments(input \\ %{}, options \\ [])

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

Link to this function list_published_schema_arns(input \\ %{}, options \\ [])

Retrieves each published schema Amazon Resource Name (ARN).

Link to this function list_tags_for_resource(input \\ %{}, options \\ [])

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.

Link to this function lookup_policy(input \\ %{}, options \\ [])

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.

Link to this function publish_schema(input \\ %{}, options \\ [])

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

Link to this function put_schema_from_json(input \\ %{}, options \\ [])

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

Link to this function remove_facet_from_object(input \\ %{}, options \\ [])

Removes the specified facet from the specified object.

Link to this function tag_resource(input \\ %{}, options \\ [])

An API operation for adding tags to a resource.

Link to this function untag_resource(input \\ %{}, options \\ [])

An API operation for removing tags from a resource.

Link to this function update_facet(input \\ %{}, options \\ [])

Does the following:

  1. Adds new `Attributes`, `Rules`, or `ObjectTypes`.
  2. Updates existing `Attributes`, `Rules`, or `ObjectTypes`.
  3. Deletes existing `Attributes`, `Rules`, or `ObjectTypes`.
Link to this function update_object_attributes(input \\ %{}, options \\ [])

Updates a given object’s attributes.

Link to this function update_schema(input \\ %{}, options \\ [])

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