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 programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

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.

ApplySchema(DirectoryArn => Str, PublishedSchemaArn => Str)

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

Returns: a Paws::CloudDirectory::ApplySchemaResponse instance

  Copies input published schema into Directory with same name and version
as that of 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(ObjectReference => Paws::CloudDirectory::ObjectReference, PolicyReference => Paws::CloudDirectory::ObjectReference, [DirectoryArn => Str])

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.

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. Batch writes supports only object-related operations.

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.

CreateFacet(Name => Str, ObjectType => Str, SchemaArn => Str, [Attributes => ArrayRef[Paws::CloudDirectory::FacetAttribute]])

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

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

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.

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.

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.

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.

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
for more information.

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

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

Returns: a Paws::CloudDirectory::ListAppliedSchemaArnsResponse instance

  Lists schemas applied to a directory.

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

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

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

Returns: a Paws::CloudDirectory::ListDevelopmentSchemaArnsResponse instance

  Retrieves the ARNs 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.

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.

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

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

Returns: a Paws::CloudDirectory::ListObjectAttributesResponse instance

  Lists all attributes associated with an object. This also supports
common namespace prefix (key) listing. For example, if you want to
retrieve all attributes associated with facet1, key can be C<facet1>.
If key is empty, all attributes are returned in a paginated list.

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 associated with a given
object.

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

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

Returns: a Paws::CloudDirectory::ListObjectParentsResponse instance

  Lists parent objects 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.

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

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

Returns: a Paws::CloudDirectory::ListPublishedSchemaArnsResponse instance

  Retrieves published schema ARNs.

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.

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.

PublishSchema(DevelopmentSchemaArn => Str, Version => 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 version. If description and
attributes are specified, PublishSchema overrides the development
schema description and attributes. If not, the development schema
description and attributes are used.

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

  API 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

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

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.

PAGINATORS

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

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

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config