AWS.CloudDirectory (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Adds a new Facet to an object.

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

Attaches an existing object to another object.

Attaches a policy object to a regular object.

Attaches the specified object to the specified index.

Attaches a typed link to a specified source and target object.

Performs all the read operations in a batch.

Performs all the write operations in a batch.

Creates a Directory by copying the published schema into the directory.

Creates a new Facet in a schema.

Creates an object in a Directory.

Creates a new schema in a development state.

Deletes an object and its associated attributes.

Detaches the specified object from the specified index.

Detaches a given object from the parent object.

Detaches a policy from an object.

Detaches a typed link from a specified source and target object.

Disables the specified directory.

Enables the specified directory.

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

Retrieves metadata about a directory.

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType.

Retrieves attributes that are associated with a typed link.

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

Retrieves metadata about an object.

Retrieves a JSON representation of the schema.

Returns the identity attribute order for a specific TypedLinkFacet.

Lists schema major versions applied to a directory.

Lists indices attached to the specified 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.

Lists objects attached to the specified index.

Lists the major version families of each managed schema.

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.

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.

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

Lists the major version families of each published schema.

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.

Returns a paginated list of TypedLink facet names for a particular schema.

Lists all policies from the root of the Directory to the object specified.

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

Allows a schema to be updated using JSON upload.

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 typed link’s attributes.

Updates a given object's attributes.

Updates the schema name with a new name.

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion.

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

Link to this section Functions

Link to this function

add_facet_to_object(client, input, options \\ [])

View Source

Adds a new Facet to an object.

An object can have more than one facet applied on it.

Link to this function

apply_schema(client, input, options \\ [])

View Source

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

Link to this function

attach_object(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

Attaches the specified object to the specified index.

Link to this function

attach_typed_link(client, input, options \\ [])

View Source

Attaches a typed link to a specified source and target object.

For more information, see Typed Links.

Link to this function

batch_read(client, input, options \\ [])

View Source

Performs all the read operations in a batch.

Link to this function

batch_write(client, input, options \\ [])

View Source

Performs all the write operations in a batch.

Either all the operations succeed or none.

Link to this function

create_directory(client, input, options \\ [])

View Source

Creates a Directory by copying the published schema into the directory.

A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

Link to this function

create_facet(client, input, options \\ [])

View Source

Creates a new Facet in a schema.

Facet creation is allowed only in development or applied schemas.

Link to this function

create_index(client, input, options \\ [])

View Source

Creates an index object.

See Indexing and search for more information.

Link to this function

create_object(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

Deletes 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 deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

Link to this function

delete_schema(client, input, options \\ [])

View Source

Deletes a given schema.

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

Link to this function

detach_from_index(client, input, options \\ [])

View Source

Detaches the specified object from the specified index.

Link to this function

detach_object(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

Detaches a policy from an object.

Link to this function

detach_typed_link(client, input, options \\ [])

View Source

Detaches a typed link from a specified source and target object.

For more information, see Typed Links.

Link to this function

disable_directory(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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_applied_schema_version(client, input, options \\ [])

View Source

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

Link to this function

get_directory(client, input, options \\ [])

View Source

Retrieves metadata about a directory.

Link to this function

get_facet(client, input, options \\ [])

View Source

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_attributes(client, input, options \\ [])

View Source

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

Link to this function

get_object_information(client, input, options \\ [])

View Source

Retrieves metadata about an object.

Link to this function

get_schema_as_json(client, input, options \\ [])

View Source

Retrieves a JSON representation of the schema.

See JSON Schema Format for more information.

Link to this function

list_applied_schema_arns(client, input, options \\ [])

View Source

Lists schema major versions applied to a directory.

If SchemaArn is provided, lists the minor version.

Link to this function

list_attached_indices(client, input, options \\ [])

View Source

Lists indices attached to the specified object.

Link to this function

list_development_schema_arns(client, input, options \\ [])

View Source

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

Link to this function

list_directories(client, input, options \\ [])

View Source

Lists directories created within an account.

Link to this function

list_facet_attributes(client, input, options \\ [])

View Source

Retrieves attributes attached to the facet.

Link to this function

list_facet_names(client, input, options \\ [])

View Source

Retrieves the names of facets that exist in a schema.

Link to this function

list_incoming_typed_links(client, input, options \\ [])

View Source

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

Link to this function

list_index(client, input, options \\ [])

View Source

Lists objects attached to the specified index.

Link to this function

list_managed_schema_arns(client, input, options \\ [])

View Source

Lists 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 listed instead.

Link to this function

list_object_attributes(client, input, options \\ [])

View Source

Lists all attributes that are associated with an object.

Link to this function

list_object_children(client, input, options \\ [])

View Source

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

Link to this function

list_object_parent_paths(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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

Link to this function

list_object_policies(client, input, options \\ [])

View Source

Returns policies attached to an object in pagination fashion.

Link to this function

list_outgoing_typed_links(client, input, options \\ [])

View Source

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

Link to this function

list_policy_attachments(client, input, options \\ [])

View Source

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

Link to this function

list_published_schema_arns(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

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

Link to this function

put_schema_from_json(client, input, options \\ [])

View Source

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(client, input, options \\ [])

View Source

Removes the specified facet from the specified object.

Link to this function

tag_resource(client, input, options \\ [])

View Source

An API operation for adding tags to a resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

An API operation for removing tags from a resource.

Link to this function

update_facet(client, input, options \\ [])

View Source

Does the following:

1.

Adds new Attributes, Rules, or ObjectTypes.

  1. Updates existing Attributes, Rules, or ObjectTypes.

  2. Deletes existing Attributes, Rules, or ObjectTypes.

Link to this function

update_object_attributes(client, input, options \\ [])

View Source

Updates a given object's attributes.

Link to this function

update_schema(client, input, options \\ [])

View Source

Updates the schema name with a new name.

Only development schema names can be updated.

Link to this function

upgrade_applied_schema(client, input, options \\ [])

View Source

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.

Link to this function

upgrade_published_schema(client, input, options \\ [])

View Source

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