NAME

Paws::CloudDirectory - Perl Interface to AWS Amazon CloudDirectory

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CloudDirectory');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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

For the AWS API documentation, see https://docs.aws.amazon.com/directory-service/

METHODS

AddFacetToObject

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
SchemaFacet => Paws::CloudDirectory::SchemaFacet
[ObjectAttributeList => ArrayRef[Paws::CloudDirectory::AttributeKeyAndValue]]

Each argument is described in detail in: Paws::CloudDirectory::AddFacetToObject

Returns: a Paws::CloudDirectory::AddFacetToObjectResponse instance

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

ApplySchema

DirectoryArn => Str
PublishedSchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::ApplySchema

Returns: a Paws::CloudDirectory::ApplySchemaResponse instance

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

ChildReference => Paws::CloudDirectory::ObjectReference
DirectoryArn => Str
LinkName => Str
ParentReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::AttachObject

Returns: a Paws::CloudDirectory::AttachObjectResponse instance

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

  1. Using the path

  2. Using ObjectIdentifier

AttachPolicy

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
PolicyReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::AttachPolicy

Returns: a Paws::CloudDirectory::AttachPolicyResponse instance

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

AttachToIndex

DirectoryArn => Str
IndexReference => Paws::CloudDirectory::ObjectReference
TargetReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::AttachToIndex

Returns: a Paws::CloudDirectory::AttachToIndexResponse instance

Attaches the specified object to the specified index.

Attributes => ArrayRef[Paws::CloudDirectory::AttributeNameAndValue]
DirectoryArn => Str
SourceObjectReference => Paws::CloudDirectory::ObjectReference
TargetObjectReference => Paws::CloudDirectory::ObjectReference
TypedLinkFacet => Paws::CloudDirectory::TypedLinkSchemaAndFacetName

Each argument is described in detail in: Paws::CloudDirectory::AttachTypedLink

Returns: a Paws::CloudDirectory::AttachTypedLinkResponse instance

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

BatchRead

DirectoryArn => Str
Operations => ArrayRef[Paws::CloudDirectory::BatchReadOperation]
[ConsistencyLevel => Str]

Each argument is described in detail in: Paws::CloudDirectory::BatchRead

Returns: a Paws::CloudDirectory::BatchReadResponse instance

Performs all the read operations in a batch.

BatchWrite

DirectoryArn => Str
Operations => ArrayRef[Paws::CloudDirectory::BatchWriteOperation]

Each argument is described in detail in: Paws::CloudDirectory::BatchWrite

Returns: a Paws::CloudDirectory::BatchWriteResponse instance

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

CreateDirectory

Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::CreateDirectory

Returns: a Paws::CloudDirectory::CreateDirectoryResponse instance

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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html) in the Amazon Cloud Directory Developer Guide.

CreateFacet

Name => Str
SchemaArn => Str
[Attributes => ArrayRef[Paws::CloudDirectory::FacetAttribute]]
[FacetStyle => Str]
[ObjectType => Str]

Each argument is described in detail in: Paws::CloudDirectory::CreateFacet

Returns: a Paws::CloudDirectory::CreateFacetResponse instance

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

CreateIndex

DirectoryArn => Str
IsUnique => Bool
OrderedIndexedAttributeList => ArrayRef[Paws::CloudDirectory::AttributeKey]
[LinkName => Str]
[ParentReference => Paws::CloudDirectory::ObjectReference]

Each argument is described in detail in: Paws::CloudDirectory::CreateIndex

Returns: a Paws::CloudDirectory::CreateIndexResponse instance

Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html) for more information.

CreateObject

DirectoryArn => Str
SchemaFacets => ArrayRef[Paws::CloudDirectory::SchemaFacet]
[LinkName => Str]
[ObjectAttributeList => ArrayRef[Paws::CloudDirectory::AttributeKeyAndValue]]
[ParentReference => Paws::CloudDirectory::ObjectReference]

Each argument is described in detail in: Paws::CloudDirectory::CreateObject

Returns: a Paws::CloudDirectory::CreateObjectResponse instance

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

Name => Str

Each argument is described in detail in: Paws::CloudDirectory::CreateSchema

Returns: a Paws::CloudDirectory::CreateSchemaResponse instance

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

Facet => Paws::CloudDirectory::TypedLinkFacet
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::CreateTypedLinkFacet

Returns: a Paws::CloudDirectory::CreateTypedLinkFacetResponse instance

Creates a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

DeleteDirectory

DirectoryArn => Str

Each argument is described in detail in: Paws::CloudDirectory::DeleteDirectory

Returns: a Paws::CloudDirectory::DeleteDirectoryResponse instance

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

DeleteFacet

Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::DeleteFacet

Returns: a Paws::CloudDirectory::DeleteFacetResponse instance

Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

DeleteObject

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::DeleteObject

Returns: a Paws::CloudDirectory::DeleteObjectResponse instance

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

DeleteSchema

SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::DeleteSchema

Returns: a Paws::CloudDirectory::DeleteSchemaResponse instance

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

DeleteTypedLinkFacet

Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::DeleteTypedLinkFacet

Returns: a Paws::CloudDirectory::DeleteTypedLinkFacetResponse instance

Deletes a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

DetachFromIndex

DirectoryArn => Str
IndexReference => Paws::CloudDirectory::ObjectReference
TargetReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::DetachFromIndex

Returns: a Paws::CloudDirectory::DetachFromIndexResponse instance

Detaches the specified object from the specified index.

DetachObject

DirectoryArn => Str
LinkName => Str
ParentReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::DetachObject

Returns: a Paws::CloudDirectory::DetachObjectResponse instance

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

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
PolicyReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::DetachPolicy

Returns: a Paws::CloudDirectory::DetachPolicyResponse instance

Detaches a policy from an object.

DirectoryArn => Str
TypedLinkSpecifier => Paws::CloudDirectory::TypedLinkSpecifier

Each argument is described in detail in: Paws::CloudDirectory::DetachTypedLink

Returns: nothing

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

DisableDirectory

DirectoryArn => Str

Each argument is described in detail in: Paws::CloudDirectory::DisableDirectory

Returns: a Paws::CloudDirectory::DisableDirectoryResponse instance

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

EnableDirectory

DirectoryArn => Str

Each argument is described in detail in: Paws::CloudDirectory::EnableDirectory

Returns: a Paws::CloudDirectory::EnableDirectoryResponse instance

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

GetAppliedSchemaVersion

SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::GetAppliedSchemaVersion

Returns: a Paws::CloudDirectory::GetAppliedSchemaVersionResponse instance

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

GetDirectory

DirectoryArn => Str

Each argument is described in detail in: Paws::CloudDirectory::GetDirectory

Returns: a Paws::CloudDirectory::GetDirectoryResponse instance

Retrieves metadata about a directory.

GetFacet

Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::GetFacet

Returns: a Paws::CloudDirectory::GetFacetResponse instance

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.

GetLinkAttributes

AttributeNames => ArrayRef[Str|Undef]
DirectoryArn => Str
TypedLinkSpecifier => Paws::CloudDirectory::TypedLinkSpecifier
[ConsistencyLevel => Str]

Each argument is described in detail in: Paws::CloudDirectory::GetLinkAttributes

Returns: a Paws::CloudDirectory::GetLinkAttributesResponse instance

Retrieves attributes that are associated with a typed link.

GetObjectAttributes

AttributeNames => ArrayRef[Str|Undef]
DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
SchemaFacet => Paws::CloudDirectory::SchemaFacet
[ConsistencyLevel => Str]

Each argument is described in detail in: Paws::CloudDirectory::GetObjectAttributes

Returns: a Paws::CloudDirectory::GetObjectAttributesResponse instance

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

GetObjectInformation

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]

Each argument is described in detail in: Paws::CloudDirectory::GetObjectInformation

Returns: a Paws::CloudDirectory::GetObjectInformationResponse instance

Retrieves metadata about an object.

GetSchemaAsJson

SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::GetSchemaAsJson

Returns: a Paws::CloudDirectory::GetSchemaAsJsonResponse instance

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.

GetTypedLinkFacetInformation

Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::GetTypedLinkFacetInformation

Returns: a Paws::CloudDirectory::GetTypedLinkFacetInformationResponse instance

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

ListAppliedSchemaArns

DirectoryArn => Str
[MaxResults => Int]
[NextToken => Str]
[SchemaArn => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListAppliedSchemaArns

Returns: a Paws::CloudDirectory::ListAppliedSchemaArnsResponse instance

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

ListAttachedIndices

DirectoryArn => Str
TargetReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListAttachedIndices

Returns: a Paws::CloudDirectory::ListAttachedIndicesResponse instance

Lists indices attached to the specified object.

ListDevelopmentSchemaArns

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListDevelopmentSchemaArns

Returns: a Paws::CloudDirectory::ListDevelopmentSchemaArnsResponse instance

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

ListDirectories

[MaxResults => Int]
[NextToken => Str]
[State => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListDirectories

Returns: a Paws::CloudDirectory::ListDirectoriesResponse instance

Lists directories created within an account.

ListFacetAttributes

Name => Str
SchemaArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListFacetAttributes

Returns: a Paws::CloudDirectory::ListFacetAttributesResponse instance

Retrieves attributes attached to the facet.

ListFacetNames

SchemaArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListFacetNames

Returns: a Paws::CloudDirectory::ListFacetNamesResponse instance

Retrieves the names of facets that exist in a schema.

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[FilterAttributeRanges => ArrayRef[Paws::CloudDirectory::TypedLinkAttributeRange]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListIncomingTypedLinks

Returns: a Paws::CloudDirectory::ListIncomingTypedLinksResponse instance

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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

ListIndex

DirectoryArn => Str
IndexReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[MaxResults => Int]
[NextToken => Str]
[RangesOnIndexedValues => ArrayRef[Paws::CloudDirectory::ObjectAttributeRange]]

Each argument is described in detail in: Paws::CloudDirectory::ListIndex

Returns: a Paws::CloudDirectory::ListIndexResponse instance

Lists objects attached to the specified index.

ListManagedSchemaArns

[MaxResults => Int]
[NextToken => Str]
[SchemaArn => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListManagedSchemaArns

Returns: a Paws::CloudDirectory::ListManagedSchemaArnsResponse instance

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

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[FacetFilter => Paws::CloudDirectory::SchemaFacet]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListObjectAttributes

Returns: a Paws::CloudDirectory::ListObjectAttributesResponse instance

Lists all attributes that are associated with an object.

ListObjectChildren

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListObjectChildren

Returns: a Paws::CloudDirectory::ListObjectChildrenResponse instance

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

ListObjectParentPaths

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListObjectParentPaths

Returns: a Paws::CloudDirectory::ListObjectParentPathsResponse instance

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

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[IncludeAllLinksToEachParent => Bool]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListObjectParents

Returns: a Paws::CloudDirectory::ListObjectParentsResponse instance

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

ListObjectPolicies

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListObjectPolicies

Returns: a Paws::CloudDirectory::ListObjectPoliciesResponse instance

Returns policies attached to an object in pagination fashion.

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[FilterAttributeRanges => ArrayRef[Paws::CloudDirectory::TypedLinkAttributeRange]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListOutgoingTypedLinks

Returns: a Paws::CloudDirectory::ListOutgoingTypedLinksResponse instance

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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

ListPolicyAttachments

DirectoryArn => Str
PolicyReference => Paws::CloudDirectory::ObjectReference
[ConsistencyLevel => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListPolicyAttachments

Returns: a Paws::CloudDirectory::ListPolicyAttachmentsResponse instance

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

ListPublishedSchemaArns

[MaxResults => Int]
[NextToken => Str]
[SchemaArn => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListPublishedSchemaArns

Returns: a Paws::CloudDirectory::ListPublishedSchemaArnsResponse instance

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

ResourceArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListTagsForResource

Returns: a Paws::CloudDirectory::ListTagsForResourceResponse instance

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

Name => Str
SchemaArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListTypedLinkFacetAttributes

Returns: a Paws::CloudDirectory::ListTypedLinkFacetAttributesResponse instance

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

ListTypedLinkFacetNames

SchemaArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::ListTypedLinkFacetNames

Returns: a Paws::CloudDirectory::ListTypedLinkFacetNamesResponse instance

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

LookupPolicy

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudDirectory::LookupPolicy

Returns: a Paws::CloudDirectory::LookupPolicyResponse instance

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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).

PublishSchema

DevelopmentSchemaArn => Str
Version => Str
[MinorVersion => Str]
[Name => Str]

Each argument is described in detail in: Paws::CloudDirectory::PublishSchema

Returns: a Paws::CloudDirectory::PublishSchemaResponse instance

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

PutSchemaFromJson

Document => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::PutSchemaFromJson

Returns: a Paws::CloudDirectory::PutSchemaFromJsonResponse instance

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.

RemoveFacetFromObject

DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference
SchemaFacet => Paws::CloudDirectory::SchemaFacet

Each argument is described in detail in: Paws::CloudDirectory::RemoveFacetFromObject

Returns: a Paws::CloudDirectory::RemoveFacetFromObjectResponse instance

Removes the specified facet from the specified object.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::CloudDirectory::Tag]

Each argument is described in detail in: Paws::CloudDirectory::TagResource

Returns: a Paws::CloudDirectory::TagResourceResponse instance

An API operation for adding tags to a resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CloudDirectory::UntagResource

Returns: a Paws::CloudDirectory::UntagResourceResponse instance

An API operation for removing tags from a resource.

UpdateFacet

Name => Str
SchemaArn => Str
[AttributeUpdates => ArrayRef[Paws::CloudDirectory::FacetAttributeUpdate]]
[ObjectType => Str]

Each argument is described in detail in: Paws::CloudDirectory::UpdateFacet

Returns: a Paws::CloudDirectory::UpdateFacetResponse instance

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

UpdateLinkAttributes

AttributeUpdates => ArrayRef[Paws::CloudDirectory::LinkAttributeUpdate]
DirectoryArn => Str
TypedLinkSpecifier => Paws::CloudDirectory::TypedLinkSpecifier

Each argument is described in detail in: Paws::CloudDirectory::UpdateLinkAttributes

Returns: a Paws::CloudDirectory::UpdateLinkAttributesResponse instance

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

AttributeUpdates => ArrayRef[Paws::CloudDirectory::ObjectAttributeUpdate]
DirectoryArn => Str
ObjectReference => Paws::CloudDirectory::ObjectReference

Each argument is described in detail in: Paws::CloudDirectory::UpdateObjectAttributes

Returns: a Paws::CloudDirectory::UpdateObjectAttributesResponse instance

Updates a given object's attributes.

UpdateSchema

Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::UpdateSchema

Returns: a Paws::CloudDirectory::UpdateSchemaResponse instance

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

UpdateTypedLinkFacet

AttributeUpdates => ArrayRef[Paws::CloudDirectory::TypedLinkFacetAttributeUpdate]
IdentityAttributeOrder => ArrayRef[Str|Undef]
Name => Str
SchemaArn => Str

Each argument is described in detail in: Paws::CloudDirectory::UpdateTypedLinkFacet

Returns: a Paws::CloudDirectory::UpdateTypedLinkFacetResponse instance

Updates a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

UpgradeAppliedSchema

DirectoryArn => Str
PublishedSchemaArn => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::CloudDirectory::UpgradeAppliedSchema

Returns: a Paws::CloudDirectory::UpgradeAppliedSchemaResponse instance

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

DevelopmentSchemaArn => Str
MinorVersion => Str
PublishedSchemaArn => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::CloudDirectory::UpgradePublishedSchema

Returns: a Paws::CloudDirectory::UpgradePublishedSchemaResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAppliedSchemaArns(sub { },DirectoryArn => Str, [MaxResults => Int, NextToken => Str, SchemaArn => Str])

ListAllAppliedSchemaArns(DirectoryArn => Str, [MaxResults => Int, NextToken => Str, SchemaArn => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SchemaArns, passing the object as the first parameter, and the string 'SchemaArns' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListAppliedSchemaArnsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllAttachedIndices(sub { },DirectoryArn => Str, TargetReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str])

ListAllAttachedIndices(DirectoryArn => Str, TargetReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - IndexAttachments, passing the object as the first parameter, and the string 'IndexAttachments' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListAttachedIndicesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDevelopmentSchemaArns(sub { },[MaxResults => Int, NextToken => Str])

ListAllDevelopmentSchemaArns([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SchemaArns, passing the object as the first parameter, and the string 'SchemaArns' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListDevelopmentSchemaArnsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDirectories(sub { },[MaxResults => Int, NextToken => Str, State => Str])

ListAllDirectories([MaxResults => Int, NextToken => Str, State => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Directories, passing the object as the first parameter, and the string 'Directories' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListDirectoriesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllFacetAttributes(sub { },Name => Str, SchemaArn => Str, [MaxResults => Int, NextToken => Str])

ListAllFacetAttributes(Name => Str, SchemaArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Attributes, passing the object as the first parameter, and the string 'Attributes' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListFacetAttributesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllFacetNames(sub { },SchemaArn => Str, [MaxResults => Int, NextToken => Str])

ListAllFacetNames(SchemaArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - FacetNames, passing the object as the first parameter, and the string 'FacetNames' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListFacetNamesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - LinkSpecifiers, passing the object as the first parameter, and the string 'LinkSpecifiers' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListIncomingTypedLinksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllIndex(sub { },DirectoryArn => Str, IndexReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str, RangesOnIndexedValues => ArrayRef[Paws::CloudDirectory::ObjectAttributeRange]])

ListAllIndex(DirectoryArn => Str, IndexReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str, RangesOnIndexedValues => ArrayRef[Paws::CloudDirectory::ObjectAttributeRange]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - IndexAttachments, passing the object as the first parameter, and the string 'IndexAttachments' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListIndexResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllManagedSchemaArns(sub { },[MaxResults => Int, NextToken => Str, SchemaArn => Str])

ListAllManagedSchemaArns([MaxResults => Int, NextToken => Str, SchemaArn => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SchemaArns, passing the object as the first parameter, and the string 'SchemaArns' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListManagedSchemaArnsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllObjectAttributes(sub { },DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, FacetFilter => Paws::CloudDirectory::SchemaFacet, MaxResults => Int, NextToken => Str])

ListAllObjectAttributes(DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, FacetFilter => Paws::CloudDirectory::SchemaFacet, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Attributes, passing the object as the first parameter, and the string 'Attributes' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListObjectAttributesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllObjectParentPaths(sub { },DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [MaxResults => Int, NextToken => Str])

ListAllObjectParentPaths(DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - PathToObjectIdentifiersList, passing the object as the first parameter, and the string 'PathToObjectIdentifiersList' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListObjectParentPathsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllObjectPolicies(sub { },DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str])

ListAllObjectPolicies(DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - AttachedPolicyIds, passing the object as the first parameter, and the string 'AttachedPolicyIds' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListObjectPoliciesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - TypedLinkSpecifiers, passing the object as the first parameter, and the string 'TypedLinkSpecifiers' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListOutgoingTypedLinksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllPolicyAttachments(sub { },DirectoryArn => Str, PolicyReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str])

ListAllPolicyAttachments(DirectoryArn => Str, PolicyReference => Paws::CloudDirectory::ObjectReference, [ConsistencyLevel => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ObjectIdentifiers, passing the object as the first parameter, and the string 'ObjectIdentifiers' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListPolicyAttachmentsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllPublishedSchemaArns(sub { },[MaxResults => Int, NextToken => Str, SchemaArn => Str])

ListAllPublishedSchemaArns([MaxResults => Int, NextToken => Str, SchemaArn => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SchemaArns, passing the object as the first parameter, and the string 'SchemaArns' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListPublishedSchemaArnsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTagsForResource(sub { },ResourceArn => Str, [MaxResults => Int, NextToken => Str])

ListAllTagsForResource(ResourceArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListTagsForResourceResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTypedLinkFacetAttributes(sub { },Name => Str, SchemaArn => Str, [MaxResults => Int, NextToken => Str])

ListAllTypedLinkFacetAttributes(Name => Str, SchemaArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Attributes, passing the object as the first parameter, and the string 'Attributes' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListTypedLinkFacetAttributesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTypedLinkFacetNames(sub { },SchemaArn => Str, [MaxResults => Int, NextToken => Str])

ListAllTypedLinkFacetNames(SchemaArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - FacetNames, passing the object as the first parameter, and the string 'FacetNames' as the second parameter 

If not, it will return a a Paws::CloudDirectory::ListTypedLinkFacetNamesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

LookupAllPolicies(sub { },DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [MaxResults => Int, NextToken => Str])

LookupAllPolicies(DirectoryArn => Str, ObjectReference => Paws::CloudDirectory::ObjectReference, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - PolicyToPathList, passing the object as the first parameter, and the string 'PolicyToPathList' as the second parameter 

If not, it will return a a Paws::CloudDirectory::LookupPolicyResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues