baiji v0.6.0 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 Rule
s 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, Rule
s, 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
Does the following
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
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:
- Using the path
- Using `ObjectIdentifier`
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:
- *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.
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 Rule
s 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, Rule
s, 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.
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.
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.
Does the following:
- Adds new `Attributes`, `Rules`, or `ObjectTypes`.
- Updates existing `Attributes`, `Rules`, or `ObjectTypes`.
- Deletes existing `Attributes`, `Rules`, or `ObjectTypes`.
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.