View Source aws_clouddirectory (aws v1.0.4)
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: https://aws.amazon.com/directoryservice/ and the Amazon Cloud Directory Developer Guide: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html.Summary
Functions
Adds a new Facet
to an object.
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 a typed link to a specified source and target object.
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 index object.
Creates an object in a Directory
.
Creates a new schema in a development state.
Creates a TypedLinkFacet
.
Deletes a directory.
Deletes a given Facet
.
Deletes an object and its associated attributes.
Deletes a given schema.
Deletes a TypedLinkFacet
.
Detaches a given object from the parent object.
Detaches a typed link from a specified source and target object.
Disables the specified directory.
Enables the specified directory.
Gets details of the Facet
, such as facet name, attributes, Rule
s, or ObjectType
.
Retrieves a JSON representation of the schema.
Returns the identity attribute order for a specific TypedLinkFacet
.
Lists schema major versions applied to a directory.
Returns a paginated list of all the incoming TypedLinkSpecifier
information for an object.
Lists the major version families of each managed schema.
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
Returns a paginated list of all the outgoing TypedLinkSpecifier
information for an object.
ObjectIdentifiers
to which a given policy is attached.Lists the major version families of each published schema.
Returns tags for a resource.
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.
Allows a schema to be updated using JSON upload.
Does the following
Updates a given typed link’s attributes.
Updates the schema name with a new name.
Updates a TypedLinkFacet
.
Upgrades a single directory in-place using the PublishedSchemaArn
with schema updates found in MinorVersion
.
DevelopmentSchemaArn
.Functions
Adds a new Facet
to an object.
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 a typed link to a specified source and target object.
For more information, see Typed Links: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink.Performs all the write operations in a batch.
Either all the operations succeed or none.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 theQuickStartSchema
. For more information, see Managed Schema: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html in the Amazon Cloud Directory Developer Guide.
Creates a new Facet
in a schema.
Creates an index object.
See Indexing and search: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html for more information.Creates an object in a Directory
.
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
.
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
.
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. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html.Deletes a given schema.
Schemas in a development and published state can only be deleted.Deletes a TypedLinkFacet
.
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 typed link from a specified source and target object.
For more information, see Typed Links: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink.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.Gets details of the Facet
, such as facet name, attributes, Rule
s, or ObjectType
.
Retrieves a JSON representation of the schema.
See JSON Schema Format: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json for more information.Returns the identity attribute order for a specific TypedLinkFacet
.
Lists schema major versions applied to a directory.
IfSchemaArn
is provided, lists the minor version.
Returns a paginated list of all the incoming TypedLinkSpecifier
information for an object.
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.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: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html.
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-definedMaxResults
, 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.
Returns a paginated list of all the outgoing TypedLinkSpecifier
information for an object.
ObjectIdentifiers
to which a given policy is attached.
Lists the major version families of each published schema.
If a major version ARN is provided asSchemaArn
, the minor version revisions in that family are listed instead.
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
.
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.
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: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies.
Allows a schema to be updated using JSON upload.
Only available for development schemas. See JSON Schema Format: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json for more information.Does the following:
Adds new
Attributes
,Rules
, orObjectTypes
.Updates existing
Attributes
,Rules
, orObjectTypes
.Deletes existing
Attributes
,Rules
, orObjectTypes
.
Updates a given typed link’s attributes.
Attributes to be updated must not contribute to the typed link’s identity, as defined by itsIdentityAttributeOrder
.
Updates the schema name with a new name.
Only development schema names can be updated.Updates a TypedLinkFacet
.
Upgrades a single directory in-place using the PublishedSchemaArn
with schema updates found in MinorVersion
.
DevelopmentSchemaArn
.