/amazonclouddirectory/2017-01-11/object/facets#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .

/amazonclouddirectory/2017-01-11/schema/apply#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns .

/amazonclouddirectory/2017-01-11/object/attach#x-amz-data-partition

Attaches an existing object to another object. An object can be accessed in two ways: Using the path Using ObjectIdentifier

• x-amz-data-partition (header, required) — Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns .

/amazonclouddirectory/2017-01-11/policy/attach#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns .

/amazonclouddirectory/2017-01-11/index/attach#x-amz-data-partition

Attaches the specified object to the specified index.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the directory where the object and index exist.

/amazonclouddirectory/2017-01-11/typedlink/attach#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

/amazonclouddirectory/2017-01-11/batchread#x-amz-data-partition

Performs all the read operations in a batch.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory . For more information, see arns .
• x-amz-consistency-level (header) — Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

/amazonclouddirectory/2017-01-11/batchwrite#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory . For more information, see arns .

/amazonclouddirectory/2017-01-11/directory/create#x-amz-data-partition

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 .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory . For more information, see arns .

/amazonclouddirectory/2017-01-11/facet/create#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The schema ARN in which the new Facet will be created. For more information, see arns .

/amazonclouddirectory/2017-01-11/index#x-amz-data-partition

Creates an index object. See Indexing and search for more information.

• x-amz-data-partition (header, required) — The ARN of the directory where the index should be created.

/amazonclouddirectory/2017-01-11/object#x-amz-data-partition

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.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns .

/amazonclouddirectory/2017-01-11/schema/create

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/2017-01-11/typedlink/facet/create#x-amz-data-partition

Creates a TypedLinkFacet . For more information, see Typed Links .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/directory#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The ARN of the directory to delete.

/amazonclouddirectory/2017-01-11/facet/delete#x-amz-data-partition

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.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Facet . For more information, see arns .

/amazonclouddirectory/2017-01-11/object/delete#x-amz-data-partition

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 .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .

/amazonclouddirectory/2017-01-11/schema#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the development schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/typedlink/facet/delete#x-amz-data-partition

Deletes a TypedLinkFacet . For more information, see Typed Links .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/index/detach#x-amz-data-partition

Detaches the specified object from the specified index.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the directory the index and object exist in.

/amazonclouddirectory/2017-01-11/object/detach#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns .

/amazonclouddirectory/2017-01-11/policy/detach#x-amz-data-partition

Detaches a policy from an object.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns .

/amazonclouddirectory/2017-01-11/typedlink/detach#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

/amazonclouddirectory/2017-01-11/directory/disable#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The ARN of the directory to disable.

/amazonclouddirectory/2017-01-11/directory/enable#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The ARN of the directory to enable.

/amazonclouddirectory/2017-01-11/schema/getappliedschema

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

/amazonclouddirectory/2017-01-11/directory/get#x-amz-data-partition

Retrieves metadata about a directory.

• x-amz-data-partition (header, required) — The ARN of the directory.

/amazonclouddirectory/2017-01-11/facet#x-amz-data-partition

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.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Facet . For more information, see arns .

/amazonclouddirectory/2017-01-11/facet#x-amz-data-partition

Does the following: Adds new Attributes , Rules , or ObjectTypes . Updates existing Attributes , Rules , or ObjectTypes . Deletes existing Attributes , Rules , or ObjectTypes .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Facet . For more information, see arns .

/amazonclouddirectory/2017-01-11/typedlink/attributes/get#x-amz-data-partition

Retrieves attributes that are associated with a typed link.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links .

/amazonclouddirectory/2017-01-11/object/attributes/get#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.
• x-amz-consistency-level (header) — The consistency level at which to retrieve the attributes on an object.

/amazonclouddirectory/2017-01-11/object/information#x-amz-data-partition

Retrieves metadata about an object.

• x-amz-data-partition (header, required) — The ARN of the directory being retrieved.
• x-amz-consistency-level (header) — The consistency level at which to retrieve the object information.

/amazonclouddirectory/2017-01-11/schema/json#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The ARN of the schema to retrieve.

/amazonclouddirectory/2017-01-11/schema/json#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The ARN of the schema to update.

/amazonclouddirectory/2017-01-11/typedlink/facet/get#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/schema/applied

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

• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/object/indices#x-amz-data-partition

Lists indices attached to the specified object.

• x-amz-data-partition (header, required) — The ARN of the directory.
• x-amz-consistency-level (header) — The consistency level to use for this operation.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/schema/development

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

• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/directory/list

Lists directories created within an account.

• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/facet/attributes#x-amz-data-partition

Retrieves attributes attached to the facet.

• x-amz-data-partition (header, required) — The ARN of the schema where the facet resides.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/facet/list#x-amz-data-partition

Retrieves the names of facets that exist in a schema.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) to retrieve facet names from.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/typedlink/incoming#x-amz-data-partition

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 .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

/amazonclouddirectory/2017-01-11/index/targets#x-amz-data-partition

Lists objects attached to the specified index.

• x-amz-data-partition (header, required) — The ARN of the directory that the index exists in.
• x-amz-consistency-level (header) — The consistency level to execute the request at.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/schema/managed

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.

• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/object/attributes#x-amz-data-partition

Lists all attributes that are associated with an object.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .
• x-amz-consistency-level (header) — Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/object/children#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .
• x-amz-consistency-level (header) — Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/object/parentpaths#x-amz-data-partition

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.

• x-amz-data-partition (header, required) — The ARN of the directory to which the parent path applies.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/object/parent#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .
• x-amz-consistency-level (header) — Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/object/policy#x-amz-data-partition

Returns policies attached to an object in pagination fashion.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns .
• x-amz-consistency-level (header) — Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/typedlink/outgoing#x-amz-data-partition

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 .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

/amazonclouddirectory/2017-01-11/policy/attachment#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns .
• x-amz-consistency-level (header) — Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/schema/published

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.

• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/tags

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.

• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/typedlink/facet/attributes#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/typedlink/facet/list#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/policy/lookup#x-amz-data-partition

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 .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory . For more information, see arns .
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/amazonclouddirectory/2017-01-11/schema/publish#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/object/facets/delete#x-amz-data-partition

Removes the specified facet from the specified object.

• x-amz-data-partition (header, required) — The ARN of the directory in which the object resides.

/amazonclouddirectory/2017-01-11/tags/add

An API operation for adding tags to a resource.

/amazonclouddirectory/2017-01-11/tags/remove

An API operation for removing tags from a resource.

/amazonclouddirectory/2017-01-11/typedlink/attributes/update#x-amz-data-partition

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 .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links .

/amazonclouddirectory/2017-01-11/object/update#x-amz-data-partition

Updates a given object's attributes.

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .

/amazonclouddirectory/2017-01-11/schema/update#x-amz-data-partition

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

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) of the development schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/typedlink/facet#x-amz-data-partition

Updates a TypedLinkFacet . For more information, see Typed Links .

• x-amz-data-partition (header, required) — The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

/amazonclouddirectory/2017-01-11/schema/upgradeapplied

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/2017-01-11/schema/upgradepublished

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