CloudDirectory

import { CloudDirectory } from "https://aws-api.deno.dev/v0.3/services/clouddirectory.ts?docs=full";

class CloudDirectory {

constructor(apiFactory: client.ApiFactory);

async addFacetToObject(params: AddFacetToObjectRequest, opts?: client.RequestOptions): Promise<void>;

async applySchema(params: ApplySchemaRequest, opts?: client.RequestOptions): Promise<ApplySchemaResponse>;

async attachObject(params: AttachObjectRequest, opts?: client.RequestOptions): Promise<AttachObjectResponse>;

async attachPolicy(params: AttachPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async attachToIndex(params: AttachToIndexRequest, opts?: client.RequestOptions): Promise<AttachToIndexResponse>;

async attachTypedLink(params: AttachTypedLinkRequest, opts?: client.RequestOptions): Promise<AttachTypedLinkResponse>;

async batchRead(params: BatchReadRequest, opts?: client.RequestOptions): Promise<BatchReadResponse>;

async batchWrite(params: BatchWriteRequest, opts?: client.RequestOptions): Promise<BatchWriteResponse>;

async createDirectory(params: CreateDirectoryRequest, opts?: client.RequestOptions): Promise<CreateDirectoryResponse>;

async createFacet(params: CreateFacetRequest, opts?: client.RequestOptions): Promise<void>;

async createIndex(params: CreateIndexRequest, opts?: client.RequestOptions): Promise<CreateIndexResponse>;

async createObject(params: CreateObjectRequest, opts?: client.RequestOptions): Promise<CreateObjectResponse>;

async createSchema(params: CreateSchemaRequest, opts?: client.RequestOptions): Promise<CreateSchemaResponse>;

async createTypedLinkFacet(params: CreateTypedLinkFacetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteDirectory(params: DeleteDirectoryRequest, opts?: client.RequestOptions): Promise<DeleteDirectoryResponse>;

async deleteFacet(params: DeleteFacetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteObject(params: DeleteObjectRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSchema(params: DeleteSchemaRequest, opts?: client.RequestOptions): Promise<DeleteSchemaResponse>;

async deleteTypedLinkFacet(params: DeleteTypedLinkFacetRequest, opts?: client.RequestOptions): Promise<void>;

async detachFromIndex(params: DetachFromIndexRequest, opts?: client.RequestOptions): Promise<DetachFromIndexResponse>;

async detachObject(params: DetachObjectRequest, opts?: client.RequestOptions): Promise<DetachObjectResponse>;

async detachPolicy(params: DetachPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async detachTypedLink(params: DetachTypedLinkRequest, opts?: client.RequestOptions): Promise<void>;

async disableDirectory(params: DisableDirectoryRequest, opts?: client.RequestOptions): Promise<DisableDirectoryResponse>;

async enableDirectory(params: EnableDirectoryRequest, opts?: client.RequestOptions): Promise<EnableDirectoryResponse>;

async getAppliedSchemaVersion(params: GetAppliedSchemaVersionRequest, opts?: client.RequestOptions): Promise<GetAppliedSchemaVersionResponse>;

async getDirectory(params: GetDirectoryRequest, opts?: client.RequestOptions): Promise<GetDirectoryResponse>;

async getFacet(params: GetFacetRequest, opts?: client.RequestOptions): Promise<GetFacetResponse>;

async getLinkAttributes(params: GetLinkAttributesRequest, opts?: client.RequestOptions): Promise<GetLinkAttributesResponse>;

async getObjectAttributes(params: GetObjectAttributesRequest, opts?: client.RequestOptions): Promise<GetObjectAttributesResponse>;

async getObjectInformation(params: GetObjectInformationRequest, opts?: client.RequestOptions): Promise<GetObjectInformationResponse>;

async getSchemaAsJson(params: GetSchemaAsJsonRequest, opts?: client.RequestOptions): Promise<GetSchemaAsJsonResponse>;

async getTypedLinkFacetInformation(params: GetTypedLinkFacetInformationRequest, opts?: client.RequestOptions): Promise<GetTypedLinkFacetInformationResponse>;

async listAppliedSchemaArns(params: ListAppliedSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListAppliedSchemaArnsResponse>;

async listAttachedIndices(params: ListAttachedIndicesRequest, opts?: client.RequestOptions): Promise<ListAttachedIndicesResponse>;

async listDevelopmentSchemaArns(params?: ListDevelopmentSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListDevelopmentSchemaArnsResponse>;

async listDirectories(params?: ListDirectoriesRequest, opts?: client.RequestOptions): Promise<ListDirectoriesResponse>;

async listFacetAttributes(params: ListFacetAttributesRequest, opts?: client.RequestOptions): Promise<ListFacetAttributesResponse>;

async listFacetNames(params: ListFacetNamesRequest, opts?: client.RequestOptions): Promise<ListFacetNamesResponse>;

async listIncomingTypedLinks(params: ListIncomingTypedLinksRequest, opts?: client.RequestOptions): Promise<ListIncomingTypedLinksResponse>;

async listIndex(params: ListIndexRequest, opts?: client.RequestOptions): Promise<ListIndexResponse>;

async listManagedSchemaArns(params?: ListManagedSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListManagedSchemaArnsResponse>;

async listObjectAttributes(params: ListObjectAttributesRequest, opts?: client.RequestOptions): Promise<ListObjectAttributesResponse>;

async listObjectChildren(params: ListObjectChildrenRequest, opts?: client.RequestOptions): Promise<ListObjectChildrenResponse>;

async listObjectParentPaths(params: ListObjectParentPathsRequest, opts?: client.RequestOptions): Promise<ListObjectParentPathsResponse>;

async listObjectParents(params: ListObjectParentsRequest, opts?: client.RequestOptions): Promise<ListObjectParentsResponse>;

async listObjectPolicies(params: ListObjectPoliciesRequest, opts?: client.RequestOptions): Promise<ListObjectPoliciesResponse>;

async listOutgoingTypedLinks(params: ListOutgoingTypedLinksRequest, opts?: client.RequestOptions): Promise<ListOutgoingTypedLinksResponse>;

async listPolicyAttachments(params: ListPolicyAttachmentsRequest, opts?: client.RequestOptions): Promise<ListPolicyAttachmentsResponse>;

async listPublishedSchemaArns(params?: ListPublishedSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListPublishedSchemaArnsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTypedLinkFacetAttributes(params: ListTypedLinkFacetAttributesRequest, opts?: client.RequestOptions): Promise<ListTypedLinkFacetAttributesResponse>;

async listTypedLinkFacetNames(params: ListTypedLinkFacetNamesRequest, opts?: client.RequestOptions): Promise<ListTypedLinkFacetNamesResponse>;

async lookupPolicy(params: LookupPolicyRequest, opts?: client.RequestOptions): Promise<LookupPolicyResponse>;

async publishSchema(params: PublishSchemaRequest, opts?: client.RequestOptions): Promise<PublishSchemaResponse>;

async putSchemaFromJson(params: PutSchemaFromJsonRequest, opts?: client.RequestOptions): Promise<PutSchemaFromJsonResponse>;

async removeFacetFromObject(params: RemoveFacetFromObjectRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateFacet(params: UpdateFacetRequest, opts?: client.RequestOptions): Promise<void>;

async updateLinkAttributes(params: UpdateLinkAttributesRequest, opts?: client.RequestOptions): Promise<void>;

async updateObjectAttributes(params: UpdateObjectAttributesRequest, opts?: client.RequestOptions): Promise<UpdateObjectAttributesResponse>;

async updateSchema(params: UpdateSchemaRequest, opts?: client.RequestOptions): Promise<UpdateSchemaResponse>;

async updateTypedLinkFacet(params: UpdateTypedLinkFacetRequest, opts?: client.RequestOptions): Promise<void>;

async upgradeAppliedSchema(params: UpgradeAppliedSchemaRequest, opts?: client.RequestOptions): Promise<UpgradeAppliedSchemaResponse>;

async upgradePublishedSchema(params: UpgradePublishedSchemaRequest, opts?: client.RequestOptions): Promise<UpgradePublishedSchemaResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new CloudDirectory(apiFactory: client.ApiFactory)

[src]

§Methods

addFacetToObject(params: AddFacetToObjectRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

applySchema(params: ApplySchemaRequest, opts?: client.RequestOptions): Promise<ApplySchemaResponse>

[src]

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

attachObject(params: AttachObjectRequest, opts?: client.RequestOptions): Promise<AttachObjectResponse>

[src]

Attaches an existing object to another object. An object can be accessed in two ways:

Using the path
Using ObjectIdentifier

attachPolicy(params: AttachPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

attachToIndex(params: AttachToIndexRequest, opts?: client.RequestOptions): Promise<AttachToIndexResponse>

[src]

Attaches the specified object to the specified index.

attachTypedLink(params: AttachTypedLinkRequest, opts?: client.RequestOptions): Promise<AttachTypedLinkResponse>

[src]

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

batchRead(params: BatchReadRequest, opts?: client.RequestOptions): Promise<BatchReadResponse>

[src]

Performs all the read operations in a batch.

batchWrite(params: BatchWriteRequest, opts?: client.RequestOptions): Promise<BatchWriteResponse>

[src]

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

createDirectory(params: CreateDirectoryRequest, opts?: client.RequestOptions): Promise<CreateDirectoryResponse>

[src]

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.

createFacet(params: CreateFacetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

createIndex(params: CreateIndexRequest, opts?: client.RequestOptions): Promise<CreateIndexResponse>

[src]

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

createObject(params: CreateObjectRequest, opts?: client.RequestOptions): Promise<CreateObjectResponse>

[src]

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.

createSchema(params: CreateSchemaRequest, opts?: client.RequestOptions): Promise<CreateSchemaResponse>

[src]

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.

createTypedLinkFacet(params: CreateTypedLinkFacetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteDirectory(params: DeleteDirectoryRequest, opts?: client.RequestOptions): Promise<DeleteDirectoryResponse>

[src]

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

deleteFacet(params: DeleteFacetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteObject(params: DeleteObjectRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteSchema(params: DeleteSchemaRequest, opts?: client.RequestOptions): Promise<DeleteSchemaResponse>

[src]

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

deleteTypedLinkFacet(params: DeleteTypedLinkFacetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

detachFromIndex(params: DetachFromIndexRequest, opts?: client.RequestOptions): Promise<DetachFromIndexResponse>

[src]

Detaches the specified object from the specified index.

detachObject(params: DetachObjectRequest, opts?: client.RequestOptions): Promise<DetachObjectResponse>

[src]

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

detachPolicy(params: DetachPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Detaches a policy from an object.

detachTypedLink(params: DetachTypedLinkRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

disableDirectory(params: DisableDirectoryRequest, opts?: client.RequestOptions): Promise<DisableDirectoryResponse>

[src]

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

enableDirectory(params: EnableDirectoryRequest, opts?: client.RequestOptions): Promise<EnableDirectoryResponse>

[src]

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

getAppliedSchemaVersion(params: GetAppliedSchemaVersionRequest, opts?: client.RequestOptions): Promise<GetAppliedSchemaVersionResponse>

[src]

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

getDirectory(params: GetDirectoryRequest, opts?: client.RequestOptions): Promise<GetDirectoryResponse>

[src]

Retrieves metadata about a directory.

getFacet(params: GetFacetRequest, opts?: client.RequestOptions): Promise<GetFacetResponse>

[src]

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.

getLinkAttributes(params: GetLinkAttributesRequest, opts?: client.RequestOptions): Promise<GetLinkAttributesResponse>

[src]

Retrieves attributes that are associated with a typed link.

getObjectAttributes(params: GetObjectAttributesRequest, opts?: client.RequestOptions): Promise<GetObjectAttributesResponse>

[src]

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

getObjectInformation(params: GetObjectInformationRequest, opts?: client.RequestOptions): Promise<GetObjectInformationResponse>

[src]

Retrieves metadata about an object.

getSchemaAsJson(params: GetSchemaAsJsonRequest, opts?: client.RequestOptions): Promise<GetSchemaAsJsonResponse>

[src]

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

getTypedLinkFacetInformation(params: GetTypedLinkFacetInformationRequest, opts?: client.RequestOptions): Promise<GetTypedLinkFacetInformationResponse>

[src]

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

listAppliedSchemaArns(params: ListAppliedSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListAppliedSchemaArnsResponse>

[src]

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

listAttachedIndices(params: ListAttachedIndicesRequest, opts?: client.RequestOptions): Promise<ListAttachedIndicesResponse>

[src]

Lists indices attached to the specified object.

listDevelopmentSchemaArns(params?: ListDevelopmentSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListDevelopmentSchemaArnsResponse>

[src]

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

listDirectories(params?: ListDirectoriesRequest, opts?: client.RequestOptions): Promise<ListDirectoriesResponse>

[src]

Lists directories created within an account.

listFacetAttributes(params: ListFacetAttributesRequest, opts?: client.RequestOptions): Promise<ListFacetAttributesResponse>

[src]

Retrieves attributes attached to the facet.

listFacetNames(params: ListFacetNamesRequest, opts?: client.RequestOptions): Promise<ListFacetNamesResponse>

[src]

Retrieves the names of facets that exist in a schema.

listIncomingTypedLinks(params: ListIncomingTypedLinksRequest, opts?: client.RequestOptions): Promise<ListIncomingTypedLinksResponse>

[src]

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.

listIndex(params: ListIndexRequest, opts?: client.RequestOptions): Promise<ListIndexResponse>

[src]

Lists objects attached to the specified index.

listManagedSchemaArns(params?: ListManagedSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListManagedSchemaArnsResponse>

[src]

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.

listObjectAttributes(params: ListObjectAttributesRequest, opts?: client.RequestOptions): Promise<ListObjectAttributesResponse>

[src]

Lists all attributes that are associated with an object.

listObjectChildren(params: ListObjectChildrenRequest, opts?: client.RequestOptions): Promise<ListObjectChildrenResponse>

[src]

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

listObjectParentPaths(params: ListObjectParentPathsRequest, opts?: client.RequestOptions): Promise<ListObjectParentPathsResponse>

[src]

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.

listObjectParents(params: ListObjectParentsRequest, opts?: client.RequestOptions): Promise<ListObjectParentsResponse>

[src]

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

listObjectPolicies(params: ListObjectPoliciesRequest, opts?: client.RequestOptions): Promise<ListObjectPoliciesResponse>

[src]

Returns policies attached to an object in pagination fashion.

listOutgoingTypedLinks(params: ListOutgoingTypedLinksRequest, opts?: client.RequestOptions): Promise<ListOutgoingTypedLinksResponse>

[src]

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.

listPolicyAttachments(params: ListPolicyAttachmentsRequest, opts?: client.RequestOptions): Promise<ListPolicyAttachmentsResponse>

[src]

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

listPublishedSchemaArns(params?: ListPublishedSchemaArnsRequest, opts?: client.RequestOptions): Promise<ListPublishedSchemaArnsResponse>

[src]

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.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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.

listTypedLinkFacetAttributes(params: ListTypedLinkFacetAttributesRequest, opts?: client.RequestOptions): Promise<ListTypedLinkFacetAttributesResponse>

[src]

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

listTypedLinkFacetNames(params: ListTypedLinkFacetNamesRequest, opts?: client.RequestOptions): Promise<ListTypedLinkFacetNamesResponse>

[src]

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

lookupPolicy(params: LookupPolicyRequest, opts?: client.RequestOptions): Promise<LookupPolicyResponse>

[src]

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.

publishSchema(params: PublishSchemaRequest, opts?: client.RequestOptions): Promise<PublishSchemaResponse>

[src]

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

putSchemaFromJson(params: PutSchemaFromJsonRequest, opts?: client.RequestOptions): Promise<PutSchemaFromJsonResponse>

[src]

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

removeFacetFromObject(params: RemoveFacetFromObjectRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified facet from the specified object.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

An API operation for adding tags to a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

An API operation for removing tags from a resource.

updateFacet(params: UpdateFacetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Does the following:

Adds new Attributes, Rules, or ObjectTypes.
Updates existing Attributes, Rules, or ObjectTypes.
Deletes existing Attributes, Rules, or ObjectTypes.

updateLinkAttributes(params: UpdateLinkAttributesRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateObjectAttributes(params: UpdateObjectAttributesRequest, opts?: client.RequestOptions): Promise<UpdateObjectAttributesResponse>

[src]

Updates a given object's attributes.

updateSchema(params: UpdateSchemaRequest, opts?: client.RequestOptions): Promise<UpdateSchemaResponse>

[src]

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

updateTypedLinkFacet(params: UpdateTypedLinkFacetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

upgradeAppliedSchema(params: UpgradeAppliedSchemaRequest, opts?: client.RequestOptions): Promise<UpgradeAppliedSchemaResponse>

[src]

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.

upgradePublishedSchema(params: UpgradePublishedSchemaRequest, opts?: client.RequestOptions): Promise<UpgradePublishedSchemaResponse>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]