Module Awso_clouddirectory_eioSource

include module type of struct include Awso_clouddirectory.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

A unique identifier for an attribute.

Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.

The combination of an attribute key and an attribute value.

Identifies the attribute name and value for a typed link.

Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached. For more information, see Policies.

The reference that identifies an object.

Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.

The action to take on the object attribute.

Represents an index and an attached object.

Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

Returns the path to the ObjectIdentifiers that is associated with the directory.

A pair of ObjectIdentifier and LinkName.

Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.

A range of attribute values. For more information, see Range Filters.

Structure that contains attribute update information.

Structure that contains attribute update information.

Identifies the range of attributes that are used by a specified filter.

A range of attributes.

A facet attribute definition. See Attribute References for more information.

The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.

Represents the output of a GetLinkAttributes response operation.

Represents the output of a GetObjectAttributes response operation.

Represents the output of a GetObjectInformation response operation.

Represents the output of a ListAttachedIndices response operation.

Represents the output of a ListIncomingTypedLinks response operation.

Represents the output of a ListIndex response operation.

Represents the output of a ListObjectAttributes response operation.

Represents the output of a ListObjectChildren response operation.

Represents the output of a ListObjectParentPaths response operation.

Represents the output of a ListObjectParents response operation.

Represents the output of a ListObjectPolicies response operation.

Represents the output of a ListOutgoingTypedLinks response operation.

Represents the output of a ListPolicyAttachments response operation.

Represents the output of a LookupPolicy response operation.

A typed link attribute definition.

An attribute that is associated with the Facet.

The result of a batch add facet to object operation.

Represents the output batch AttachObject response operation.

Represents the output of an AttachPolicy response operation.

Represents the output of a AttachToIndex response operation.

Represents the output of a AttachTypedLink response operation.

Represents the output of a CreateIndex response operation.

Represents the output of a CreateObject response operation.

Represents the output of a DeleteObject response operation.

Represents the output of a DetachFromIndex response operation.

Represents the output of a DetachObject response operation.

Represents the output of a DetachPolicy response operation.

Represents the output of a DetachTypedLink response operation.

An empty result that represents success.

Represents the output of a UpdateLinkAttributes response operation.

Represents the output of a BatchUpdate response operation.

Represents the output of a batch add facet to object operation.

Represents the output of an AttachObject operation.

Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.

Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.

Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

Represents the output of a CreateObject operation.

Represents the output of a DeleteObject operation.

Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.

Represents the output of a DetachObject operation.

Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.

Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.

A batch operation to remove a facet from an object.

Updates a given typed link’s attributes inside a BatchRead operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. For more information, see UpdateLinkAttributes and BatchReadRequest$Operations.

Represents the output of a BatchUpdate operation.

The batch read exception structure, which contains the exception type and message.

Represents the output of a BatchRead success response operation.

Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.

Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations.

Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.

Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations.

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

Represents the output of a ListObjectAttributes operation.

Represents the output of a ListObjectChildren operation.

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations.

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

Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.

Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations.

A typed link facet attribute update.

A structure that contains information used to update an attribute.

The tag structure that contains a tag key and value.

Directory structure that includes the directory name and directory ARN.

Represents the output of a BatchWrite response operation.

Represents the output of a BatchWrite operation.

Represents the output of a BatchRead response operation.

Represents the output of a BatchRead operation.

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

Indicates that the provided ARN value is not valid.

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

Indicates that limits are exceeded. See Limits for more information.

The specified resource could not be found.

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

Indicates that your request is malformed in some manner. See the exception message.

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

The specified Facet could not be found.

The Facet that you provided was not well formed or could not be validated with the schema.

An attempt to modify a Facet resulted in an invalid schema exception.

Occurs when any of the rule parameter keys or values are invalid.

Operations are only permitted on enabled directories.

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.

Indicates that the provided SchemaDoc value is not valid.

Indicates that a schema is already published.

Indicates that the NextToken value is not valid.

Indicates that the requested operation can only operate on policy objects.

Cannot list the parents of a Directory root.

Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.

Indicates that the requested operation can only operate on index objects.

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See Facets for more information.

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

Indicates that the object is not attached to the index.

The object could not be deleted because links still exist. Remove the links and then try the operation again.

Indicates that the requested operation cannot be completed because the object has not been detached from the tree.

Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.

An operation can only operate on a disabled directory.

A facet with the same name already exists.

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

Indicates that the requested index type is not supported.

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

A BatchWrite exception has occurred.

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

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

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

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.

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.

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

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

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

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

Updates a given object's attributes.

Updates a given object's attributes.

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.

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.

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

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

An API operation for removing tags from a resource.

An API operation for removing tags from a resource.

An API operation for adding tags to a resource.

An API operation for adding tags to a resource.

Removes the specified facet from the specified object.

Removes the specified facet from the specified object.

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

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

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

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

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.

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.

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

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

Sourcemodule ListTypedLinkFacetAttributesResponse = Awso_clouddirectory.Values.ListTypedLinkFacetAttributesResponse

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

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

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

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.

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.

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

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

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.

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.

Returns policies attached to an object in pagination fashion.

Returns policies attached to an object in pagination fashion.

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

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

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.

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.

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

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

Lists all attributes that are associated with an object.

Lists all attributes that are associated with 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.

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.

Lists objects attached to the specified index.

Lists objects attached to the specified index.

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.

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.

Retrieves the names of facets that exist in a schema.

Retrieves the names of facets that exist in a schema.

Retrieves attributes attached to the facet.

Retrieves attributes attached to the facet.

Lists directories created within an account.

Lists directories created within an account.

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

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

Lists indices attached to the specified object.

Lists indices attached to the specified object.

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

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

Sourcemodule GetTypedLinkFacetInformationResponse = Awso_clouddirectory.Values.GetTypedLinkFacetInformationResponse

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

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

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

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

Retrieves metadata about an object.

Retrieves metadata about an object.

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

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

Retrieves attributes that are associated with a typed link.

Retrieves attributes that are associated with a typed link.

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.

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 a directory.

Retrieves metadata about a directory.

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

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

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

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

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

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

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

Detaches a policy from an object.

Detaches a policy from an object.

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 given object from the parent object. The object that is to be detached from the parent is specified by the link name.

Detaches the specified object from the specified index.

Detaches the specified object from the specified index.

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

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

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

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

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.

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.

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 a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

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

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

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

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

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 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 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 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 an index object. See Indexing and search for more information.

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

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

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

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.

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.

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

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

Performs all the read operations in a batch.

Performs all the read operations in a batch.

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

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

Attaches the specified object to the specified index.

Attaches the specified object to the specified index.

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

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

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

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

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

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

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

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