SDK for PHP 3.x

Client: Aws\CloudDirectory\CloudDirectoryClient
Service ID: clouddirectory
Version: 2017-01-11

This page describes the parameters and results for the operations of the Amazon CloudDirectory (2017-01-11), and shows how to use the Aws\CloudDirectory\CloudDirectoryClient object to call the described operations. This documentation is specific to the 2017-01-11 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddFacetToObject ( array $params = [] )
Adds a new Facet to an object.
ApplySchema ( array $params = [] )
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 ( array $params = [] )
Attaches an existing object to another object.
AttachPolicy ( array $params = [] )
Attaches a policy object to a regular object.
AttachToIndex ( array $params = [] )
Attaches the specified object to the specified index.
AttachTypedLink ( array $params = [] )
Attaches a typed link to a specified source and target object.
BatchRead ( array $params = [] )
Performs all the read operations in a batch.
BatchWrite ( array $params = [] )
Performs all the write operations in a batch.
CreateDirectory ( array $params = [] )
Creates a Directory by copying the published schema into the directory.
CreateFacet ( array $params = [] )
Creates a new Facet in a schema.
CreateIndex ( array $params = [] )
Creates an index object.
CreateObject ( array $params = [] )
Creates an object in a Directory.
CreateSchema ( array $params = [] )
Creates a new schema in a development state.
CreateTypedLinkFacet ( array $params = [] )
Creates a TypedLinkFacet.
DeleteDirectory ( array $params = [] )
Deletes a directory.
DeleteFacet ( array $params = [] )
Deletes a given Facet.
DeleteObject ( array $params = [] )
Deletes an object and its associated attributes.
DeleteSchema ( array $params = [] )
Deletes a given schema.
DeleteTypedLinkFacet ( array $params = [] )
Deletes a TypedLinkFacet.
DetachFromIndex ( array $params = [] )
Detaches the specified object from the specified index.
DetachObject ( array $params = [] )
Detaches a given object from the parent object.
DetachPolicy ( array $params = [] )
Detaches a policy from an object.
DetachTypedLink ( array $params = [] )
Detaches a typed link from a specified source and target object.
DisableDirectory ( array $params = [] )
Disables the specified directory.
EnableDirectory ( array $params = [] )
Enables the specified directory.
GetAppliedSchemaVersion ( array $params = [] )
Returns current applied schema version ARN, including the minor version in use.
GetDirectory ( array $params = [] )
Retrieves metadata about a directory.
GetFacet ( array $params = [] )
Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType.
GetLinkAttributes ( array $params = [] )
Retrieves attributes that are associated with a typed link.
GetObjectAttributes ( array $params = [] )
Retrieves attributes within a facet that are associated with an object.
GetObjectInformation ( array $params = [] )
Retrieves metadata about an object.
GetSchemaAsJson ( array $params = [] )
Retrieves a JSON representation of the schema.
GetTypedLinkFacetInformation ( array $params = [] )
Returns the identity attribute order for a specific TypedLinkFacet.
ListAppliedSchemaArns ( array $params = [] )
Lists schema major versions applied to a directory.
ListAttachedIndices ( array $params = [] )
Lists indices attached to the specified object.
ListDevelopmentSchemaArns ( array $params = [] )
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
ListDirectories ( array $params = [] )
Lists directories created within an account.
ListFacetAttributes ( array $params = [] )
Retrieves attributes attached to the facet.
ListFacetNames ( array $params = [] )
Retrieves the names of facets that exist in a schema.
ListIncomingTypedLinks ( array $params = [] )
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
ListIndex ( array $params = [] )
Lists objects attached to the specified index.
ListManagedSchemaArns ( array $params = [] )
Lists the major version families of each managed schema.
ListObjectAttributes ( array $params = [] )
Lists all attributes that are associated with an object.
ListObjectChildren ( array $params = [] )
Returns a paginated list of child objects that are associated with a given object.
ListObjectParentPaths ( array $params = [] )
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
ListObjectParents ( array $params = [] )
Lists parent objects that are associated with a given object in pagination fashion.
ListObjectPolicies ( array $params = [] )
Returns policies attached to an object in pagination fashion.
ListOutgoingTypedLinks ( array $params = [] )
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
ListPolicyAttachments ( array $params = [] )
Returns all of the ObjectIdentifiers to which a given policy is attached.
ListPublishedSchemaArns ( array $params = [] )
Lists the major version families of each published schema.
ListTagsForResource ( array $params = [] )
Returns tags for a resource.
ListTypedLinkFacetAttributes ( array $params = [] )
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
ListTypedLinkFacetNames ( array $params = [] )
Returns a paginated list of TypedLink facet names for a particular schema.
LookupPolicy ( array $params = [] )
Lists all policies from the root of the Directory to the object specified.
PublishSchema ( array $params = [] )
Publishes a development schema with a major version and a recommended minor version.
PutSchemaFromJson ( array $params = [] )
Allows a schema to be updated using JSON upload.
RemoveFacetFromObject ( array $params = [] )
Removes the specified facet from the specified object.
TagResource ( array $params = [] )
An API operation for adding tags to a resource.
UntagResource ( array $params = [] )
An API operation for removing tags from a resource.
UpdateFacet ( array $params = [] )
Does the following: Adds new Attributes, Rules, or ObjectTypes.
UpdateLinkAttributes ( array $params = [] )
Updates a given typed link’s attributes.
UpdateObjectAttributes ( array $params = [] )
Updates a given object's attributes.
UpdateSchema ( array $params = [] )
Updates the schema name with a new name.
UpdateTypedLinkFacet ( array $params = [] )
Updates a TypedLinkFacet.
UpgradeAppliedSchema ( array $params = [] )
Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion.
UpgradePublishedSchema ( array $params = [] )
Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAppliedSchemaArns
ListAttachedIndices
ListDevelopmentSchemaArns
ListDirectories
ListFacetAttributes
ListFacetNames
ListIndex
ListManagedSchemaArns
ListObjectAttributes
ListObjectChildren
ListObjectParentPaths
ListObjectParents
ListObjectPolicies
ListPolicyAttachments
ListPublishedSchemaArns
ListTagsForResource
ListTypedLinkFacetAttributes
ListTypedLinkFacetNames
LookupPolicy

Operations

AddFacetToObject

$result = $client->addFacetToObject([/* ... */]);
$promise = $client->addFacetToObjectAsync([/* ... */]);

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

Parameter Syntax

$result = $client->addFacetToObject([
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectAttributeList' => [
        [
            'Key' => [ // REQUIRED
                'FacetName' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'SchemaArn' => '<string>', // REQUIRED
            ],
            'Value' => [ // REQUIRED
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <integer || string || DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'SchemaFacet' => [ // REQUIRED
        'FacetName' => '<string>',
        'SchemaArn' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectAttributeList
Type: Array of AttributeKeyAndValue structures

Attributes on the facet that you are adding to the object.

ObjectReference
Required: Yes
Type: ObjectReference structure

A reference to the object you are adding the specified facet to.

SchemaFacet
Required: Yes
Type: SchemaFacet structure

Identifiers for the facet that you are adding to the object. See SchemaFacet for details.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

Examples

Example 1: To add a facet to an object

$result = $client->addFacetToObject([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectAttributeList' => [
    ],
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ',
    ],
    'SchemaFacet' => [
        'FacetName' => 'node1',
        'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
    ],
]);

Result syntax:

[
]

ApplySchema

$result = $client->applySchema([/* ... */]);
$promise = $client->applySchemaAsync([/* ... */]);

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

Parameter Syntax

$result = $client->applySchema([
    'DirectoryArn' => '<string>', // REQUIRED
    'PublishedSchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.

PublishedSchemaArn
Required: Yes
Type: string

Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

Result Syntax

[
    'AppliedSchemaArn' => '<string>',
    'DirectoryArn' => '<string>',
]

Result Details

Members
AppliedSchemaArn
Type: string

The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

DirectoryArn
Type: string

The ARN that is associated with the Directory. For more information, see arns.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

SchemaAlreadyExistsException:

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

ResourceNotFoundException:

The specified resource could not be found.

InvalidAttachmentException:

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.

Examples

Example 1: To apply a schema

$result = $client->applySchema([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI',
    'PublishedSchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/published/org/1',
]);

Result syntax:

[
    'AppliedSchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/org/1',
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI',
]

AttachObject

$result = $client->attachObject([/* ... */]);
$promise = $client->attachObjectAsync([/* ... */]);

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

  1. Using the path

  2. Using ObjectIdentifier

Parameter Syntax

$result = $client->attachObject([
    'ChildReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'DirectoryArn' => '<string>', // REQUIRED
    'LinkName' => '<string>', // REQUIRED
    'ParentReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ChildReference
Required: Yes
Type: ObjectReference structure

The child object reference to be attached to the object.

DirectoryArn
Required: Yes
Type: string

Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

LinkName
Required: Yes
Type: string

The link name with which the child object is attached to the parent.

ParentReference
Required: Yes
Type: ObjectReference structure

The parent object reference.

Result Syntax

[
    'AttachedObjectIdentifier' => '<string>',
]

Result Details

Members
AttachedObjectIdentifier
Type: string

The attached ObjectIdentifier, which is the child ObjectIdentifier.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

LinkNameAlreadyInUseException:

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

InvalidAttachmentException:

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.

ValidationException:

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

FacetValidationException:

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

Examples

Example 1: To attach an object

$result = $client->attachObject([
    'ChildReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
    ],
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'LinkName' => 'link2',
    'ParentReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'AttachedObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
]

AttachPolicy

$result = $client->attachPolicy([/* ... */]);
$promise = $client->attachPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->attachPolicy([
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'PolicyReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object to which the policy will be attached.

PolicyReference
Required: Yes
Type: ObjectReference structure

The reference that is associated with the policy object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

NotPolicyException:

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

Examples

Example 1: To attach a policy to an object

$result = $client->attachPolicy([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw',
    ],
    'PolicyReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew',
    ],
]);

Result syntax:

[
]

AttachToIndex

$result = $client->attachToIndex([/* ... */]);
$promise = $client->attachToIndexAsync([/* ... */]);

Attaches the specified object to the specified index.

Parameter Syntax

$result = $client->attachToIndex([
    'DirectoryArn' => '<string>', // REQUIRED
    'IndexReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'TargetReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the directory where the object and index exist.

IndexReference
Required: Yes
Type: ObjectReference structure

A reference to the index that you are attaching the object to.

TargetReference
Required: Yes
Type: ObjectReference structure

A reference to the object that you are attaching to the index.

Result Syntax

[
    'AttachedObjectIdentifier' => '<string>',
]

Result Details

Members
AttachedObjectIdentifier
Type: string

The ObjectIdentifier of the object that was attached to the index.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

InvalidAttachmentException:

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.

ResourceNotFoundException:

The specified resource could not be found.

LinkNameAlreadyInUseException:

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

IndexedAttributeMissingException:

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

NotIndexException:

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

Examples

Example 1: To attach a index to an object

$result = $client->attachToIndex([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'IndexReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q',
    ],
    'TargetReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'AttachedObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
]
$result = $client->attachTypedLink([/* ... */]);
$promise = $client->attachTypedLinkAsync([/* ... */]);

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

Parameter Syntax

$result = $client->attachTypedLink([
    'Attributes' => [ // REQUIRED
        [
            'AttributeName' => '<string>', // REQUIRED
            'Value' => [ // REQUIRED
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <integer || string || DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'DirectoryArn' => '<string>', // REQUIRED
    'SourceObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'TargetObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'TypedLinkFacet' => [ // REQUIRED
        'SchemaArn' => '<string>', // REQUIRED
        'TypedLinkName' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
Attributes
Required: Yes
Type: Array of AttributeNameAndValue structures

A set of attributes that are associated with the typed link.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

SourceObjectReference
Required: Yes
Type: ObjectReference structure

Identifies the source object that the typed link will attach to.

TargetObjectReference
Required: Yes
Type: ObjectReference structure

Identifies the target object that the typed link will attach to.

TypedLinkFacet
Required: Yes
Type: TypedLinkSchemaAndFacetName structure

Identifies the typed link facet that is associated with the typed link.

Result Syntax

[
    'TypedLinkSpecifier' => [
        'IdentityAttributeValues' => [
            [
                'AttributeName' => '<string>',
                'Value' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
            // ...
        ],
        'SourceObjectReference' => [
            'Selector' => '<string>',
        ],
        'TargetObjectReference' => [
            'Selector' => '<string>',
        ],
        'TypedLinkFacet' => [
            'SchemaArn' => '<string>',
            'TypedLinkName' => '<string>',
        ],
    ],
]

Result Details

Members
TypedLinkSpecifier
Type: TypedLinkSpecifier structure

Returns a typed link specifier as output.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidAttachmentException:

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.

ValidationException:

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

FacetValidationException:

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

Examples

$result = $client->attachTypedLink([
    'Attributes' => [
        [
            'AttributeName' => '22',
            'Value' => [
                'BinaryValue' => <BLOB>,
            ],
        ],
    ],
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'SourceObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
    ],
    'TargetObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
    'TypedLinkFacet' => [
        'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
        'TypedLinkName' => 'exampletypedlink8',
    ],
]);

Result syntax:

[
    'TypedLinkSpecifier' => [
        'IdentityAttributeValues' => [
            [
                'AttributeName' => '22',
                'Value' => [
                    'BinaryValue' => <BLOB>,
                ],
            ],
        ],
        'SourceObjectReference' => [
            'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
        ],
        'TargetObjectReference' => [
            'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
        ],
        'TypedLinkFacet' => [
            'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
            'TypedLinkName' => 'exampletypedlink8',
        ],
    ],
]

BatchRead

$result = $client->batchRead([/* ... */]);
$promise = $client->batchReadAsync([/* ... */]);

Performs all the read operations in a batch.

Parameter Syntax

$result = $client->batchRead([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'Operations' => [ // REQUIRED
        [
            'GetLinkAttributes' => [
                'AttributeNames' => ['<string>', ...], // REQUIRED
                'TypedLinkSpecifier' => [ // REQUIRED
                    'IdentityAttributeValues' => [ // REQUIRED
                        [
                            'AttributeName' => '<string>', // REQUIRED
                            'Value' => [ // REQUIRED
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'SourceObjectReference' => [ // REQUIRED
                        'Selector' => '<string>',
                    ],
                    'TargetObjectReference' => [ // REQUIRED
                        'Selector' => '<string>',
                    ],
                    'TypedLinkFacet' => [ // REQUIRED
                        'SchemaArn' => '<string>', // REQUIRED
                        'TypedLinkName' => '<string>', // REQUIRED
                    ],
                ],
            ],
            'GetObjectAttributes' => [
                'AttributeNames' => ['<string>', ...], // REQUIRED
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'SchemaFacet' => [ // REQUIRED
                    'FacetName' => '<string>',
                    'SchemaArn' => '<string>',
                ],
            ],
            'GetObjectInformation' => [
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListAttachedIndices' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'TargetReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListIncomingTypedLinks' => [
                'FilterAttributeRanges' => [
                    [
                        'AttributeName' => '<string>',
                        'Range' => [ // REQUIRED
                            'EndMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                            'EndValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                            'StartMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                            'StartValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'FilterTypedLink' => [
                    'SchemaArn' => '<string>', // REQUIRED
                    'TypedLinkName' => '<string>', // REQUIRED
                ],
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListIndex' => [
                'IndexReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'RangesOnIndexedValues' => [
                    [
                        'AttributeKey' => [
                            'FacetName' => '<string>', // REQUIRED
                            'Name' => '<string>', // REQUIRED
                            'SchemaArn' => '<string>', // REQUIRED
                        ],
                        'Range' => [
                            'EndMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                            'EndValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                            'StartMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                            'StartValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'ListObjectAttributes' => [
                'FacetFilter' => [
                    'FacetName' => '<string>',
                    'SchemaArn' => '<string>',
                ],
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListObjectChildren' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListObjectParentPaths' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListObjectParents' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListObjectPolicies' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListOutgoingTypedLinks' => [
                'FilterAttributeRanges' => [
                    [
                        'AttributeName' => '<string>',
                        'Range' => [ // REQUIRED
                            'EndMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                            'EndValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                            'StartMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                            'StartValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'FilterTypedLink' => [
                    'SchemaArn' => '<string>', // REQUIRED
                    'TypedLinkName' => '<string>', // REQUIRED
                ],
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'ListPolicyAttachments' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'PolicyReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'LookupPolicy' => [
                'MaxResults' => <integer>,
                'NextToken' => '<string>',
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

Operations
Required: Yes
Type: Array of BatchReadOperation structures

A list of operations that are part of the batch.

Result Syntax

[
    'Responses' => [
        [
            'ExceptionResponse' => [
                'Message' => '<string>',
                'Type' => 'ValidationException|InvalidArnException|ResourceNotFoundException|InvalidNextTokenException|AccessDeniedException|NotNodeException|FacetValidationException|CannotListParentOfRootException|NotIndexException|NotPolicyException|DirectoryNotEnabledException|LimitExceededException|InternalServiceException',
            ],
            'SuccessfulResponse' => [
                'GetLinkAttributes' => [
                    'Attributes' => [
                        [
                            'Key' => [
                                'FacetName' => '<string>',
                                'Name' => '<string>',
                                'SchemaArn' => '<string>',
                            ],
                            'Value' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                'GetObjectAttributes' => [
                    'Attributes' => [
                        [
                            'Key' => [
                                'FacetName' => '<string>',
                                'Name' => '<string>',
                                'SchemaArn' => '<string>',
                            ],
                            'Value' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                'GetObjectInformation' => [
                    'ObjectIdentifier' => '<string>',
                    'SchemaFacets' => [
                        [
                            'FacetName' => '<string>',
                            'SchemaArn' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ListAttachedIndices' => [
                    'IndexAttachments' => [
                        [
                            'IndexedAttributes' => [
                                [
                                    'Key' => [
                                        'FacetName' => '<string>',
                                        'Name' => '<string>',
                                        'SchemaArn' => '<string>',
                                    ],
                                    'Value' => [
                                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        'BooleanValue' => true || false,
                                        'DatetimeValue' => <DateTime>,
                                        'NumberValue' => '<string>',
                                        'StringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'ObjectIdentifier' => '<string>',
                        ],
                        // ...
                    ],
                    'NextToken' => '<string>',
                ],
                'ListIncomingTypedLinks' => [
                    'LinkSpecifiers' => [
                        [
                            'IdentityAttributeValues' => [
                                [
                                    'AttributeName' => '<string>',
                                    'Value' => [
                                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        'BooleanValue' => true || false,
                                        'DatetimeValue' => <DateTime>,
                                        'NumberValue' => '<string>',
                                        'StringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'SourceObjectReference' => [
                                'Selector' => '<string>',
                            ],
                            'TargetObjectReference' => [
                                'Selector' => '<string>',
                            ],
                            'TypedLinkFacet' => [
                                'SchemaArn' => '<string>',
                                'TypedLinkName' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'NextToken' => '<string>',
                ],
                'ListIndex' => [
                    'IndexAttachments' => [
                        [
                            'IndexedAttributes' => [
                                [
                                    'Key' => [
                                        'FacetName' => '<string>',
                                        'Name' => '<string>',
                                        'SchemaArn' => '<string>',
                                    ],
                                    'Value' => [
                                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        'BooleanValue' => true || false,
                                        'DatetimeValue' => <DateTime>,
                                        'NumberValue' => '<string>',
                                        'StringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'ObjectIdentifier' => '<string>',
                        ],
                        // ...
                    ],
                    'NextToken' => '<string>',
                ],
                'ListObjectAttributes' => [
                    'Attributes' => [
                        [
                            'Key' => [
                                'FacetName' => '<string>',
                                'Name' => '<string>',
                                'SchemaArn' => '<string>',
                            ],
                            'Value' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'NextToken' => '<string>',
                ],
                'ListObjectChildren' => [
                    'Children' => ['<string>', ...],
                    'NextToken' => '<string>',
                ],
                'ListObjectParentPaths' => [
                    'NextToken' => '<string>',
                    'PathToObjectIdentifiersList' => [
                        [
                            'ObjectIdentifiers' => ['<string>', ...],
                            'Path' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ListObjectParents' => [
                    'NextToken' => '<string>',
                    'ParentLinks' => [
                        [
                            'LinkName' => '<string>',
                            'ObjectIdentifier' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ListObjectPolicies' => [
                    'AttachedPolicyIds' => ['<string>', ...],
                    'NextToken' => '<string>',
                ],
                'ListOutgoingTypedLinks' => [
                    'NextToken' => '<string>',
                    'TypedLinkSpecifiers' => [
                        [
                            'IdentityAttributeValues' => [
                                [
                                    'AttributeName' => '<string>',
                                    'Value' => [
                                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        'BooleanValue' => true || false,
                                        'DatetimeValue' => <DateTime>,
                                        'NumberValue' => '<string>',
                                        'StringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'SourceObjectReference' => [
                                'Selector' => '<string>',
                            ],
                            'TargetObjectReference' => [
                                'Selector' => '<string>',
                            ],
                            'TypedLinkFacet' => [
                                'SchemaArn' => '<string>',
                                'TypedLinkName' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                'ListPolicyAttachments' => [
                    'NextToken' => '<string>',
                    'ObjectIdentifiers' => ['<string>', ...],
                ],
                'LookupPolicy' => [
                    'NextToken' => '<string>',
                    'PolicyToPathList' => [
                        [
                            'Path' => '<string>',
                            'Policies' => [
                                [
                                    'ObjectIdentifier' => '<string>',
                                    'PolicyId' => '<string>',
                                    'PolicyType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
Responses
Type: Array of BatchReadOperationResponse structures

A list of all the responses for each batch read.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

Examples

Example 1: To run a batch read command

$result = $client->batchRead([
    'ConsistencyLevel' => 'EVENTUAL',
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'Operations' => [
    ],
]);

Result syntax:

[
    'Responses' => [
    ],
]

BatchWrite

$result = $client->batchWrite([/* ... */]);
$promise = $client->batchWriteAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchWrite([
    'DirectoryArn' => '<string>', // REQUIRED
    'Operations' => [ // REQUIRED
        [
            'AddFacetToObject' => [
                'ObjectAttributeList' => [ // REQUIRED
                    [
                        'Key' => [ // REQUIRED
                            'FacetName' => '<string>', // REQUIRED
                            'Name' => '<string>', // REQUIRED
                            'SchemaArn' => '<string>', // REQUIRED
                        ],
                        'Value' => [ // REQUIRED
                            'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BooleanValue' => true || false,
                            'DatetimeValue' => <integer || string || DateTime>,
                            'NumberValue' => '<string>',
                            'StringValue' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'SchemaFacet' => [ // REQUIRED
                    'FacetName' => '<string>',
                    'SchemaArn' => '<string>',
                ],
            ],
            'AttachObject' => [
                'ChildReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'LinkName' => '<string>', // REQUIRED
                'ParentReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'AttachPolicy' => [
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'PolicyReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'AttachToIndex' => [
                'IndexReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'TargetReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'AttachTypedLink' => [
                'Attributes' => [ // REQUIRED
                    [
                        'AttributeName' => '<string>', // REQUIRED
                        'Value' => [ // REQUIRED
                            'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BooleanValue' => true || false,
                            'DatetimeValue' => <integer || string || DateTime>,
                            'NumberValue' => '<string>',
                            'StringValue' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'SourceObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'TargetObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'TypedLinkFacet' => [ // REQUIRED
                    'SchemaArn' => '<string>', // REQUIRED
                    'TypedLinkName' => '<string>', // REQUIRED
                ],
            ],
            'CreateIndex' => [
                'BatchReferenceName' => '<string>',
                'IsUnique' => true || false, // REQUIRED
                'LinkName' => '<string>',
                'OrderedIndexedAttributeList' => [ // REQUIRED
                    [
                        'FacetName' => '<string>', // REQUIRED
                        'Name' => '<string>', // REQUIRED
                        'SchemaArn' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'ParentReference' => [
                    'Selector' => '<string>',
                ],
            ],
            'CreateObject' => [
                'BatchReferenceName' => '<string>',
                'LinkName' => '<string>',
                'ObjectAttributeList' => [ // REQUIRED
                    [
                        'Key' => [ // REQUIRED
                            'FacetName' => '<string>', // REQUIRED
                            'Name' => '<string>', // REQUIRED
                            'SchemaArn' => '<string>', // REQUIRED
                        ],
                        'Value' => [ // REQUIRED
                            'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BooleanValue' => true || false,
                            'DatetimeValue' => <integer || string || DateTime>,
                            'NumberValue' => '<string>',
                            'StringValue' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'ParentReference' => [
                    'Selector' => '<string>',
                ],
                'SchemaFacet' => [ // REQUIRED
                    [
                        'FacetName' => '<string>',
                        'SchemaArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DeleteObject' => [
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'DetachFromIndex' => [
                'IndexReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'TargetReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'DetachObject' => [
                'BatchReferenceName' => '<string>',
                'LinkName' => '<string>', // REQUIRED
                'ParentReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'DetachPolicy' => [
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'PolicyReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
            'DetachTypedLink' => [
                'TypedLinkSpecifier' => [ // REQUIRED
                    'IdentityAttributeValues' => [ // REQUIRED
                        [
                            'AttributeName' => '<string>', // REQUIRED
                            'Value' => [ // REQUIRED
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'SourceObjectReference' => [ // REQUIRED
                        'Selector' => '<string>',
                    ],
                    'TargetObjectReference' => [ // REQUIRED
                        'Selector' => '<string>',
                    ],
                    'TypedLinkFacet' => [ // REQUIRED
                        'SchemaArn' => '<string>', // REQUIRED
                        'TypedLinkName' => '<string>', // REQUIRED
                    ],
                ],
            ],
            'RemoveFacetFromObject' => [
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
                'SchemaFacet' => [ // REQUIRED
                    'FacetName' => '<string>',
                    'SchemaArn' => '<string>',
                ],
            ],
            'UpdateLinkAttributes' => [
                'AttributeUpdates' => [ // REQUIRED
                    [
                        'AttributeAction' => [
                            'AttributeActionType' => 'CREATE_OR_UPDATE|DELETE',
                            'AttributeUpdateValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        'AttributeKey' => [
                            'FacetName' => '<string>', // REQUIRED
                            'Name' => '<string>', // REQUIRED
                            'SchemaArn' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'TypedLinkSpecifier' => [ // REQUIRED
                    'IdentityAttributeValues' => [ // REQUIRED
                        [
                            'AttributeName' => '<string>', // REQUIRED
                            'Value' => [ // REQUIRED
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'SourceObjectReference' => [ // REQUIRED
                        'Selector' => '<string>',
                    ],
                    'TargetObjectReference' => [ // REQUIRED
                        'Selector' => '<string>',
                    ],
                    'TypedLinkFacet' => [ // REQUIRED
                        'SchemaArn' => '<string>', // REQUIRED
                        'TypedLinkName' => '<string>', // REQUIRED
                    ],
                ],
            ],
            'UpdateObjectAttributes' => [
                'AttributeUpdates' => [ // REQUIRED
                    [
                        'ObjectAttributeAction' => [
                            'ObjectAttributeActionType' => 'CREATE_OR_UPDATE|DELETE',
                            'ObjectAttributeUpdateValue' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <integer || string || DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        'ObjectAttributeKey' => [
                            'FacetName' => '<string>', // REQUIRED
                            'Name' => '<string>', // REQUIRED
                            'SchemaArn' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'ObjectReference' => [ // REQUIRED
                    'Selector' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

Operations
Required: Yes
Type: Array of BatchWriteOperation structures

A list of operations that are part of the batch.

Result Syntax

[
    'Responses' => [
        [
            'AddFacetToObject' => [
            ],
            'AttachObject' => [
                'attachedObjectIdentifier' => '<string>',
            ],
            'AttachPolicy' => [
            ],
            'AttachToIndex' => [
                'AttachedObjectIdentifier' => '<string>',
            ],
            'AttachTypedLink' => [
                'TypedLinkSpecifier' => [
                    'IdentityAttributeValues' => [
                        [
                            'AttributeName' => '<string>',
                            'Value' => [
                                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'BooleanValue' => true || false,
                                'DatetimeValue' => <DateTime>,
                                'NumberValue' => '<string>',
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'SourceObjectReference' => [
                        'Selector' => '<string>',
                    ],
                    'TargetObjectReference' => [
                        'Selector' => '<string>',
                    ],
                    'TypedLinkFacet' => [
                        'SchemaArn' => '<string>',
                        'TypedLinkName' => '<string>',
                    ],
                ],
            ],
            'CreateIndex' => [
                'ObjectIdentifier' => '<string>',
            ],
            'CreateObject' => [
                'ObjectIdentifier' => '<string>',
            ],
            'DeleteObject' => [
            ],
            'DetachFromIndex' => [
                'DetachedObjectIdentifier' => '<string>',
            ],
            'DetachObject' => [
                'detachedObjectIdentifier' => '<string>',
            ],
            'DetachPolicy' => [
            ],
            'DetachTypedLink' => [
            ],
            'RemoveFacetFromObject' => [
            ],
            'UpdateLinkAttributes' => [
            ],
            'UpdateObjectAttributes' => [
                'ObjectIdentifier' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
Responses
Type: Array of BatchWriteOperationResponse structures

A list of all the responses for each batch write.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

BatchWriteException:

A BatchWrite exception has occurred.

Examples

Example 1: To run a batch write command

$result = $client->batchWrite([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'Operations' => [
    ],
]);

Result syntax:

[
    'Responses' => [
    ],
]

CreateDirectory

$result = $client->createDirectory([/* ... */]);
$promise = $client->createDirectoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDirectory([
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the Directory. Should be unique per account, per region.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Result Syntax

[
    'AppliedSchemaArn' => '<string>',
    'DirectoryArn' => '<string>',
    'Name' => '<string>',
    'ObjectIdentifier' => '<string>',
]

Result Details

Members
AppliedSchemaArn
Required: Yes
Type: string

The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

DirectoryArn
Required: Yes
Type: string

The ARN that is associated with the Directory. For more information, see arns.

Name
Required: Yes
Type: string

The name of the Directory.

ObjectIdentifier
Required: Yes
Type: string

The root object node of the created directory.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryAlreadyExistsException:

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

ResourceNotFoundException:

The specified resource could not be found.

Examples

Example 1: To create a new Cloud Directory

$result = $client->createDirectory([
    'Name' => 'ExampleCD',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1',
]);

Result syntax:

[
    'AppliedSchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/person/1',
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI',
    'Name' => 'ExampleCD',
    'ObjectIdentifier' => 'AQHzK-KsptZGU78KjmnwGH6i-4guCM3uQFOTA9_NjeHDrg',
]

CreateFacet

$result = $client->createFacet([/* ... */]);
$promise = $client->createFacetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createFacet([
    'Attributes' => [
        [
            'AttributeDefinition' => [
                'DefaultValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'IsImmutable' => true || false,
                'Rules' => [
                    '<RuleKey>' => [
                        'Parameters' => ['<string>', ...],
                        'Type' => 'BINARY_LENGTH|NUMBER_COMPARISON|STRING_FROM_SET|STRING_LENGTH',
                    ],
                    // ...
                ],
                'Type' => 'STRING|BINARY|BOOLEAN|NUMBER|DATETIME|VARIANT', // REQUIRED
            ],
            'AttributeReference' => [
                'TargetAttributeName' => '<string>', // REQUIRED
                'TargetFacetName' => '<string>', // REQUIRED
            ],
            'Name' => '<string>', // REQUIRED
            'RequiredBehavior' => 'REQUIRED_ALWAYS|NOT_REQUIRED',
        ],
        // ...
    ],
    'FacetStyle' => 'STATIC|DYNAMIC',
    'Name' => '<string>', // REQUIRED
    'ObjectType' => 'NODE|LEAF_NODE|POLICY|INDEX',
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Attributes
Type: Array of FacetAttribute structures

The attributes that are associated with the Facet.

FacetStyle
Type: string

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

Name
Required: Yes
Type: string

The name of the Facet, which is unique for a given schema.

ObjectType
Type: string

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.

  • Leaf node: Cannot have children but can have multiple parents.

  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.

  • Index: Can be created with the Index API.

SchemaArn
Required: Yes
Type: string

The schema ARN in which the new Facet will be created. For more information, see arns.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetAlreadyExistsException:

A facet with the same name already exists.

InvalidRuleException:

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

FacetValidationException:

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

Examples

Example 1: To create a facet

$result = $client->createFacet([
    'Name' => 'node1',
    'ObjectType' => 'NODE',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
]);

Result syntax:

[
]

CreateIndex

$result = $client->createIndex([/* ... */]);
$promise = $client->createIndexAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createIndex([
    'DirectoryArn' => '<string>', // REQUIRED
    'IsUnique' => true || false, // REQUIRED
    'LinkName' => '<string>',
    'OrderedIndexedAttributeList' => [ // REQUIRED
        [
            'FacetName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
            'SchemaArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ParentReference' => [
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory where the index should be created.

IsUnique
Required: Yes
Type: boolean

Indicates whether the attribute that is being indexed has unique values or not.

LinkName
Type: string

The name of the link between the parent object and the index object.

OrderedIndexedAttributeList
Required: Yes
Type: Array of AttributeKey structures

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

ParentReference
Type: ObjectReference structure

A reference to the parent object that contains the index object.

Result Syntax

[
    'ObjectIdentifier' => '<string>',
]

Result Details

Members
ObjectIdentifier
Type: string

The ObjectIdentifier of the index created by this operation.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

LinkNameAlreadyInUseException:

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

UnsupportedIndexTypeException:

Indicates that the requested index type is not supported.

Examples

Example 1: To create an index

$result = $client->createIndex([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
    'IsUnique' => 1,
    'LinkName' => 'Examplelink',
    'OrderedIndexedAttributeList' => [
    ],
    'ParentReference' => [
    ],
]);

Result syntax:

[
    'ObjectIdentifier' => 'AQF0Fw173YJDlpLUV1eB50WvYsWFtVoUSmOzZjz_BLULIA',
]

CreateObject

$result = $client->createObject([/* ... */]);
$promise = $client->createObjectAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createObject([
    'DirectoryArn' => '<string>', // REQUIRED
    'LinkName' => '<string>',
    'ObjectAttributeList' => [
        [
            'Key' => [ // REQUIRED
                'FacetName' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'SchemaArn' => '<string>', // REQUIRED
            ],
            'Value' => [ // REQUIRED
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <integer || string || DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'ParentReference' => [
        'Selector' => '<string>',
    ],
    'SchemaFacets' => [ // REQUIRED
        [
            'FacetName' => '<string>',
            'SchemaArn' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

LinkName
Type: string

The name of link that is used to attach this object to a parent.

ObjectAttributeList
Type: Array of AttributeKeyAndValue structures

The attribute map whose attribute ARN contains the key and attribute value as the map value.

ParentReference
Type: ObjectReference structure

If specified, the parent reference to which this object will be attached.

SchemaFacets
Required: Yes
Type: Array of SchemaFacet structures

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

Result Syntax

[
    'ObjectIdentifier' => '<string>',
]

Result Details

Members
ObjectIdentifier
Type: string

The identifier that is associated with the object.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

LinkNameAlreadyInUseException:

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

UnsupportedIndexTypeException:

Indicates that the requested index type is not supported.

Examples

Example 1: To create an object

$result = $client->createObject([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
    'SchemaFacets' => [
        [
            'FacetName' => 'Organization_Person',
            'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8/schema/ExampleOrgPersonSchema/1',
        ],
    ],
]);

Result syntax:

[
    'ObjectIdentifier' => 'AQF0Fw173YJDlpLUV1eB50WvScvjsYXcS3K2nP1HwDuuYQ',
]

CreateSchema

$result = $client->createSchema([/* ... */]);
$promise = $client->createSchemaAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createSchema([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name that is associated with the schema. This is unique to each account and in each region.

Result Syntax

[
    'SchemaArn' => '<string>',
]

Result Details

Members
SchemaArn
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

SchemaAlreadyExistsException:

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

AccessDeniedException:

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.

Examples

Example 1: To create a schema

$result = $client->createSchema([
    'Name' => 'Customers',
]);

Result syntax:

[
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers',
]

CreateTypedLinkFacet

$result = $client->createTypedLinkFacet([/* ... */]);
$promise = $client->createTypedLinkFacetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createTypedLinkFacet([
    'Facet' => [ // REQUIRED
        'Attributes' => [ // REQUIRED
            [
                'DefaultValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'IsImmutable' => true || false,
                'Name' => '<string>', // REQUIRED
                'RequiredBehavior' => 'REQUIRED_ALWAYS|NOT_REQUIRED', // REQUIRED
                'Rules' => [
                    '<RuleKey>' => [
                        'Parameters' => ['<string>', ...],
                        'Type' => 'BINARY_LENGTH|NUMBER_COMPARISON|STRING_FROM_SET|STRING_LENGTH',
                    ],
                    // ...
                ],
                'Type' => 'STRING|BINARY|BOOLEAN|NUMBER|DATETIME|VARIANT', // REQUIRED
            ],
            // ...
        ],
        'IdentityAttributeOrder' => ['<string>', ...], // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Facet
Required: Yes
Type: TypedLinkFacet structure

Facet structure that is associated with the typed link facet.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetAlreadyExistsException:

A facet with the same name already exists.

InvalidRuleException:

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

FacetValidationException:

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

Examples

Example 1: To create a typed link facet

$result = $client->createTypedLinkFacet([
    'Facet' => [
        'Attributes' => [
            [
                'Name' => '1',
                'RequiredBehavior' => 'REQUIRED_ALWAYS',
                'Type' => 'BINARY',
            ],
        ],
        'IdentityAttributeOrder' => [
            '1',
        ],
        'Name' => 'FacetExample',
    ],
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschema',
]);

Result syntax:

[
]

DeleteDirectory

$result = $client->deleteDirectory([/* ... */]);
$promise = $client->deleteDirectoryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteDirectory([
    'DirectoryArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory to delete.

Result Syntax

[
    'DirectoryArn' => '<string>',
]

Result Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the deleted directory.

Errors

ResourceNotFoundException:

The specified resource could not be found.

DirectoryNotDisabledException:

An operation can only operate on a disabled directory.

InternalServiceException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryDeletedException:

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

RetryableConflictException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

Examples

Example 1: To delete a directory

$result = $client->deleteDirectory([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
]);

Result syntax:

[
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
]

DeleteFacet

$result = $client->deleteFacet([/* ... */]);
$promise = $client->deleteFacetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteFacet([
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the facet to delete.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

FacetInUseException:

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

Examples

Example 1: To delete a facet

$result = $client->deleteFacet([
    'Name' => 'Organization',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest',
]);

Result syntax:

[
]

DeleteObject

$result = $client->deleteObject([/* ... */]);
$promise = $client->deleteObjectAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteObject([
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference
Required: Yes
Type: ObjectReference structure

A reference that identifies the object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

ObjectNotDetachedException:

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

Examples

Example 1: To delete an object

$result = $client->deleteObject([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI',
    'ObjectReference' => [
        'Selector' => '$AQHzK-KsptZGU78KjmnwGH6i8H-voMZDSNCqfx-fRUcBFg',
    ],
]);

Result syntax:

[
]

DeleteSchema

$result = $client->deleteSchema([/* ... */]);
$promise = $client->deleteSchemaAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteSchema([
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

Result Syntax

[
    'SchemaArn' => '<string>',
]

Result Details

Members
SchemaArn
Type: string

The input ARN that is returned as part of the response. For more information, see arns.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

StillContainsLinksException:

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

Examples

Example 1: To delete a schema

$result = $client->deleteSchema([
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest',
]);

Result syntax:

[
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest',
]

DeleteTypedLinkFacet

$result = $client->deleteTypedLinkFacet([/* ... */]);
$promise = $client->deleteTypedLinkFacetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteTypedLinkFacet([
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The unique name of the typed link facet.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

Examples

Example 1: To delete a typed link facet

$result = $client->deleteTypedLinkFacet([
    'Name' => 'ExampleFacet',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest',
]);

Result syntax:

[
]

DetachFromIndex

$result = $client->detachFromIndex([/* ... */]);
$promise = $client->detachFromIndexAsync([/* ... */]);

Detaches the specified object from the specified index.

Parameter Syntax

$result = $client->detachFromIndex([
    'DirectoryArn' => '<string>', // REQUIRED
    'IndexReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'TargetReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the directory the index and object exist in.

IndexReference
Required: Yes
Type: ObjectReference structure

A reference to the index object.

TargetReference
Required: Yes
Type: ObjectReference structure

A reference to the object being detached from the index.

Result Syntax

[
    'DetachedObjectIdentifier' => '<string>',
]

Result Details

Members
DetachedObjectIdentifier
Type: string

The ObjectIdentifier of the object that was detached from the index.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

ObjectAlreadyDetachedException:

Indicates that the object is not attached to the index.

NotIndexException:

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

Examples

Example 1: To detach an object from an index

$result = $client->detachFromIndex([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'IndexReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q',
    ],
    'TargetReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'DetachedObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
]

DetachObject

$result = $client->detachObject([/* ... */]);
$promise = $client->detachObjectAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detachObject([
    'DirectoryArn' => '<string>', // REQUIRED
    'LinkName' => '<string>', // REQUIRED
    'ParentReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

LinkName
Required: Yes
Type: string

The link name associated with the object that needs to be detached.

ParentReference
Required: Yes
Type: ObjectReference structure

The parent reference from which the object with the specified link name is detached.

Result Syntax

[
    'DetachedObjectIdentifier' => '<string>',
]

Result Details

Members
DetachedObjectIdentifier
Type: string

The ObjectIdentifier that was detached from the object.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

NotNodeException:

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

Examples

Example 1: To detach an object from its parent object

$result = $client->detachObject([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'LinkName' => 'link2',
    'ParentReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'DetachedObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
]

DetachPolicy

$result = $client->detachPolicy([/* ... */]);
$promise = $client->detachPolicyAsync([/* ... */]);

Detaches a policy from an object.

Parameter Syntax

$result = $client->detachPolicy([
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'PolicyReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose policy object will be detached.

PolicyReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the policy object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

NotPolicyException:

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

Examples

Example 1: To detach a policy from an object

$result = $client->detachPolicy([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw',
    ],
    'PolicyReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew',
    ],
]);

Result syntax:

[
]
$result = $client->detachTypedLink([/* ... */]);
$promise = $client->detachTypedLinkAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detachTypedLink([
    'DirectoryArn' => '<string>', // REQUIRED
    'TypedLinkSpecifier' => [ // REQUIRED
        'IdentityAttributeValues' => [ // REQUIRED
            [
                'AttributeName' => '<string>', // REQUIRED
                'Value' => [ // REQUIRED
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
            // ...
        ],
        'SourceObjectReference' => [ // REQUIRED
            'Selector' => '<string>',
        ],
        'TargetObjectReference' => [ // REQUIRED
            'Selector' => '<string>',
        ],
        'TypedLinkFacet' => [ // REQUIRED
            'SchemaArn' => '<string>', // REQUIRED
            'TypedLinkName' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

TypedLinkSpecifier
Required: Yes
Type: TypedLinkSpecifier structure

Used to accept a typed link specifier as input.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

Examples

$result = $client->detachTypedLink([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'TypedLinkSpecifier' => [
        'IdentityAttributeValues' => [
            [
                'AttributeName' => '22',
                'Value' => [
                    'BinaryValue' => <BLOB>,
                ],
            ],
        ],
        'SourceObjectReference' => [
            'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
        ],
        'TargetObjectReference' => [
            'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
        ],
        'TypedLinkFacet' => [
            'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
            'TypedLinkName' => 'exampletypedlink8',
        ],
    ],
]);

DisableDirectory

$result = $client->disableDirectory([/* ... */]);
$promise = $client->disableDirectoryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disableDirectory([
    'DirectoryArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory to disable.

Result Syntax

[
    'DirectoryArn' => '<string>',
]

Result Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory that has been disabled.

Errors

ResourceNotFoundException:

The specified resource could not be found.

DirectoryDeletedException:

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

InternalServiceException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

RetryableConflictException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

Examples

Example 1: To disable a directory

$result = $client->disableDirectory([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
]);

Result syntax:

[
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
]

EnableDirectory

$result = $client->enableDirectory([/* ... */]);
$promise = $client->enableDirectoryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->enableDirectory([
    'DirectoryArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory to enable.

Result Syntax

[
    'DirectoryArn' => '<string>',
]

Result Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the enabled directory.

Errors

ResourceNotFoundException:

The specified resource could not be found.

DirectoryDeletedException:

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

InternalServiceException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

RetryableConflictException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

Examples

Example 1: To enable a disabled directory

$result = $client->enableDirectory([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
]);

Result syntax:

[
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
]

GetAppliedSchemaVersion

$result = $client->getAppliedSchemaVersion([/* ... */]);
$promise = $client->getAppliedSchemaVersionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getAppliedSchemaVersion([
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
SchemaArn
Required: Yes
Type: string

The ARN of the applied schema.

Result Syntax

[
    'AppliedSchemaArn' => '<string>',
]

Result Details

Members
AppliedSchemaArn
Type: string

Current applied schema ARN, including the minor version in use if one was provided.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

GetDirectory

$result = $client->getDirectory([/* ... */]);
$promise = $client->getDirectoryAsync([/* ... */]);

Retrieves metadata about a directory.

Parameter Syntax

$result = $client->getDirectory([
    'DirectoryArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory.

Result Syntax

[
    'Directory' => [
        'CreationDateTime' => <DateTime>,
        'DirectoryArn' => '<string>',
        'Name' => '<string>',
        'State' => 'ENABLED|DISABLED|DELETED',
    ],
]

Result Details

Members
Directory
Required: Yes
Type: Directory structure

Metadata about the directory.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

Examples

Example 1: To get information about a directory

$result = $client->getDirectory([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
]);

Result syntax:

[
    'Directory' => [
        'CreationDateTime' => ,
        'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
        'Name' => 'ExampleCD',
        'State' => 'ENABLED',
    ],
]

GetFacet

$result = $client->getFacet([/* ... */]);
$promise = $client->getFacetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getFacet([
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the facet to retrieve.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

Result Syntax

[
    'Facet' => [
        'FacetStyle' => 'STATIC|DYNAMIC',
        'Name' => '<string>',
        'ObjectType' => 'NODE|LEAF_NODE|POLICY|INDEX',
    ],
]

Result Details

Members
Facet
Type: Facet structure

The Facet structure that is associated with the facet.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

Examples

Example 1: To get information about a facet

$result = $client->getFacet([
    'Name' => 'node2',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
]);

Result syntax:

[
    'Facet' => [
        'Name' => 'node2',
        'ObjectType' => 'NODE',
    ],
]

GetLinkAttributes

$result = $client->getLinkAttributes([/* ... */]);
$promise = $client->getLinkAttributesAsync([/* ... */]);

Retrieves attributes that are associated with a typed link.

Parameter Syntax

$result = $client->getLinkAttributes([
    'AttributeNames' => ['<string>', ...], // REQUIRED
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'TypedLinkSpecifier' => [ // REQUIRED
        'IdentityAttributeValues' => [ // REQUIRED
            [
                'AttributeName' => '<string>', // REQUIRED
                'Value' => [ // REQUIRED
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
            // ...
        ],
        'SourceObjectReference' => [ // REQUIRED
            'Selector' => '<string>',
        ],
        'TargetObjectReference' => [ // REQUIRED
            'Selector' => '<string>',
        ],
        'TypedLinkFacet' => [ // REQUIRED
            'SchemaArn' => '<string>', // REQUIRED
            'TypedLinkName' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
AttributeNames
Required: Yes
Type: Array of strings

A list of attribute names whose values will be retrieved.

ConsistencyLevel
Type: string

The consistency level at which to retrieve the attributes on a typed link.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.

TypedLinkSpecifier
Required: Yes
Type: TypedLinkSpecifier structure

Allows a typed link specifier to be accepted as input.

Result Syntax

[
    'Attributes' => [
        [
            'Key' => [
                'FacetName' => '<string>',
                'Name' => '<string>',
                'SchemaArn' => '<string>',
            ],
            'Value' => [
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
Attributes
Type: Array of AttributeKeyAndValue structures

The attributes that are associated with the typed link.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

GetObjectAttributes

$result = $client->getObjectAttributes([/* ... */]);
$promise = $client->getObjectAttributesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getObjectAttributes([
    'AttributeNames' => ['<string>', ...], // REQUIRED
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'SchemaFacet' => [ // REQUIRED
        'FacetName' => '<string>',
        'SchemaArn' => '<string>',
    ],
]);

Parameter Details

Members
AttributeNames
Required: Yes
Type: Array of strings

List of attribute names whose values will be retrieved.

ConsistencyLevel
Type: string

The consistency level at which to retrieve the attributes on an object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose attributes will be retrieved.

SchemaFacet
Required: Yes
Type: SchemaFacet structure

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

Result Syntax

[
    'Attributes' => [
        [
            'Key' => [
                'FacetName' => '<string>',
                'Name' => '<string>',
                'SchemaArn' => '<string>',
            ],
            'Value' => [
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
Attributes
Type: Array of AttributeKeyAndValue structures

The attributes that are associated with the object.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

GetObjectInformation

$result = $client->getObjectInformation([/* ... */]);
$promise = $client->getObjectInformationAsync([/* ... */]);

Retrieves metadata about an object.

Parameter Syntax

$result = $client->getObjectInformation([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

The consistency level at which to retrieve the object information.

DirectoryArn
Required: Yes
Type: string

The ARN of the directory being retrieved.

ObjectReference
Required: Yes
Type: ObjectReference structure

A reference to the object.

Result Syntax

[
    'ObjectIdentifier' => '<string>',
    'SchemaFacets' => [
        [
            'FacetName' => '<string>',
            'SchemaArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ObjectIdentifier
Type: string

The ObjectIdentifier of the specified object.

SchemaFacets
Type: Array of SchemaFacet structures

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

Examples

Example 1: To get information about an object

$result = $client->getObjectInformation([
    'ConsistencyLevel' => 'SERIALIZABLE',
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ',
    ],
]);

Result syntax:

[
    'ObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ',
    'SchemaFacets' => [
        [
            'FacetName' => 'node2',
            'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
        ],
    ],
]

GetSchemaAsJson

$result = $client->getSchemaAsJson([/* ... */]);
$promise = $client->getSchemaAsJsonAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getSchemaAsJson([
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
SchemaArn
Required: Yes
Type: string

The ARN of the schema to retrieve.

Result Syntax

[
    'Document' => '<string>',
    'Name' => '<string>',
]

Result Details

Members
Document
Type: string

The JSON representation of the schema document.

Name
Type: string

The name of the retrieved schema.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

ValidationException:

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

Examples

Example 1: To get schema information and display it in JSON format

$result = $client->getSchemaAsJson([
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
]);

Result syntax:

[
    'Document' => '{"sourceSchemaArn":"arn:aws:clouddirectory:us-west-2:45132example:schema/published/org/1","facets":{"node2":{"facetAttributes":{},"objectType":"NODE"},"Organization":{"facetAttributes":{"account_id":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"account_name":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"telephone_number":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"description":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_country":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_state":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_street2":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_street1":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"web_site":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"email":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_city":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"organization_status":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_postal_code":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"}},"objectType":"LEAF_NODE"},"nodex":{"facetAttributes":{},"objectType":"NODE"},"Legal_Entity":{"facetAttributes":{"industry_vertical":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"registered_company_name":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"billing_currency":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_country":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_state":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_street2":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_street1":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"tax_id":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_city":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"},"mailing_address_postal_code":{"attributeDefinition":{"attributeType":"STRING","isImmutable":false,"attributeRules":{"nameLength":{"parameters":{"min":"1","max":"1024"},"ruleType":"STRING_LENGTH"}}},"requiredBehavior":"NOT_REQUIRED"}},"objectType":"LEAF_NODE"},"policyfacet":{"facetAttributes":{},"objectType":"POLICY"},"node1":{"facetAttributes":{},"objectType":"NODE"}},"typedLinkFacets":{"exampletypedlink":{"facetAttributes":{"1":{"attributeDefinition":{"attributeType":"BINARY","isImmutable":false,"attributeRules":{}},"requiredBehavior":"REQUIRED_ALWAYS"}},"identityAttributeOrder":["1"]},"exampletypedlink8":{"facetAttributes":{"22":{"attributeDefinition":{"attributeType":"BINARY","isImmutable":false,"attributeRules":{}},"requiredBehavior":"REQUIRED_ALWAYS"}},"identityAttributeOrder":["22"]}}}',
    'Name' => 'org',
]

GetTypedLinkFacetInformation

$result = $client->getTypedLinkFacetInformation([/* ... */]);
$promise = $client->getTypedLinkFacetInformationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getTypedLinkFacetInformation([
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The unique name of the typed link facet.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Result Syntax

[
    'IdentityAttributeOrder' => ['<string>', ...],
]

Result Details

Members
IdentityAttributeOrder
Type: Array of strings

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

FacetNotFoundException:

The specified Facet could not be found.

Examples

Example 1: To get information about a typed link facet

$result = $client->getTypedLinkFacetInformation([
    'Name' => 'exampletypedlink8',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
]);

Result syntax:

[
    'IdentityAttributeOrder' => [
        '22',
    ],
]

ListAppliedSchemaArns

$result = $client->listAppliedSchemaArns([/* ... */]);
$promise = $client->listAppliedSchemaArnsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAppliedSchemaArns([
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaArn' => '<string>',
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory you are listing.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

SchemaArn
Type: string

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

Result Syntax

[
    'NextToken' => '<string>',
    'SchemaArns' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

The pagination token.

SchemaArns
Type: Array of strings

The ARNs of schemas that are applied to the directory.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

Examples

Example 1: To list applied schema ARNs for a specified directory

$result = $client->listAppliedSchemaArns([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
]);

Result syntax:

[
    'SchemaArns' => [
        'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
    ],
]

ListAttachedIndices

$result = $client->listAttachedIndices([/* ... */]);
$promise = $client->listAttachedIndicesAsync([/* ... */]);

Lists indices attached to the specified object.

Parameter Syntax

$result = $client->listAttachedIndices([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TargetReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

The consistency level to use for this operation.

DirectoryArn
Required: Yes
Type: string

The ARN of the directory.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

TargetReference
Required: Yes
Type: ObjectReference structure

A reference to the object that has indices attached.

Result Syntax

[
    'IndexAttachments' => [
        [
            'IndexedAttributes' => [
                [
                    'Key' => [
                        'FacetName' => '<string>',
                        'Name' => '<string>',
                        'SchemaArn' => '<string>',
                    ],
                    'Value' => [
                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BooleanValue' => true || false,
                        'DatetimeValue' => <DateTime>,
                        'NumberValue' => '<string>',
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'ObjectIdentifier' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
IndexAttachments
Type: Array of IndexAttachment structures

The indices attached to the specified object.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

Examples

Example 1: To list the indices attached to an object

$result = $client->listAttachedIndices([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'TargetReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'IndexAttachments' => [
        [
            'IndexedAttributes' => [
            ],
            'ObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q',
        ],
    ],
]

ListDevelopmentSchemaArns

$result = $client->listDevelopmentSchemaArns([/* ... */]);
$promise = $client->listDevelopmentSchemaArnsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDevelopmentSchemaArns([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

Result Syntax

[
    'NextToken' => '<string>',
    'SchemaArns' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

The pagination token.

SchemaArns
Type: Array of strings

The ARNs of retrieved development schemas.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

Examples

Example 1: To list all development schema arns in your AWS account

$result = $client->listDevelopmentSchemaArns([
]);

Result syntax:

[
    'SchemaArns' => [
        'arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest',
        'arn:aws:clouddirectory:us-west-2:45132example:schema/development/testCDschema',
        'arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers',
        'arn:aws:clouddirectory:us-west-2:45132example:schema/development/CourseCatalog',
        'arn:aws:clouddirectory:us-west-2:45132example:schema/development/Consumers',
        'arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorg',
    ],
]

ListDirectories

$result = $client->listDirectories([/* ... */]);
$promise = $client->listDirectoriesAsync([/* ... */]);

Lists directories created within an account.

Parameter Syntax

$result = $client->listDirectories([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'state' => 'ENABLED|DISABLED|DELETED',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

state
Type: string

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Result Syntax

[
    'Directories' => [
        [
            'CreationDateTime' => <DateTime>,
            'DirectoryArn' => '<string>',
            'Name' => '<string>',
            'State' => 'ENABLED|DISABLED|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Directories
Required: Yes
Type: Array of Directory structures

Lists all directories that are associated with your account in pagination fashion.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

Examples

Example 1: To list all directories in your AWS account

$result = $client->listDirectories([
]);

Result syntax:

[
    'Directories' => [
        [
            'CreationDateTime' => ,
            'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/Ae89hOKmw0bRpvYgW8EAsus',
            'Name' => 'ExampleCD4',
            'State' => 'ENABLED',
        ],
        [
            'CreationDateTime' => ,
            'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8',
            'Name' => 'testCD',
            'State' => 'DELETED',
        ],
        [
            'CreationDateTime' => ,
            'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
            'Name' => 'ExampleCD',
            'State' => 'ENABLED',
        ],
        [
            'CreationDateTime' => ,
            'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI',
            'Name' => 'ExampleCD2',
            'State' => 'ENABLED',
        ],
        [
            'CreationDateTime' => ,
            'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AWeI1yjiB0SylWVTvQklCD0',
            'Name' => 'testCD2',
            'State' => 'DELETED',
        ],
    ],
]

ListFacetAttributes

$result = $client->listFacetAttributes([/* ... */]);
$promise = $client->listFacetAttributesAsync([/* ... */]);

Retrieves attributes attached to the facet.

Parameter Syntax

$result = $client->listFacetAttributes([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

Name
Required: Yes
Type: string

The name of the facet whose attributes will be retrieved.

NextToken
Type: string

The pagination token.

SchemaArn
Required: Yes
Type: string

The ARN of the schema where the facet resides.

Result Syntax

[
    'Attributes' => [
        [
            'AttributeDefinition' => [
                'DefaultValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'IsImmutable' => true || false,
                'Rules' => [
                    '<RuleKey>' => [
                        'Parameters' => ['<string>', ...],
                        'Type' => 'BINARY_LENGTH|NUMBER_COMPARISON|STRING_FROM_SET|STRING_LENGTH',
                    ],
                    // ...
                ],
                'Type' => 'STRING|BINARY|BOOLEAN|NUMBER|DATETIME|VARIANT',
            ],
            'AttributeReference' => [
                'TargetAttributeName' => '<string>',
                'TargetFacetName' => '<string>',
            ],
            'Name' => '<string>',
            'RequiredBehavior' => 'REQUIRED_ALWAYS|NOT_REQUIRED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Attributes
Type: Array of FacetAttribute structures

The attributes attached to the facet.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

Examples

Example 1: To list facet attributes

$result = $client->listFacetAttributes([
    'Name' => 'Organization',
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
]);

Result syntax:

[
    'Attributes' => [
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'account_id',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'account_name',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'description',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'email',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'mailing_address_city',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'mailing_address_country',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'mailing_address_postal_code',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'mailing_address_state',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'mailing_address_street1',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
        [
            'AttributeDefinition' => [
                'IsImmutable' => ,
                'Rules' => [
                    'nameLength' => [
                        'Parameters' => [
                            'max' => '1024',
                            'min' => '1',
                        ],
                        'Type' => 'STRING_LENGTH',
                    ],
                ],
                'Type' => 'STRING',
            ],
            'Name' => 'mailing_address_street2',
            'RequiredBehavior' => 'NOT_REQUIRED',
        ],
    ],
    'NextToken' => 'V0b3JnYW5pemF0aW9uX3N0YXR1cw==',
]

ListFacetNames

$result = $client->listFacetNames([/* ... */]);
$promise = $client->listFacetNamesAsync([/* ... */]);

Retrieves the names of facets that exist in a schema.

Parameter Syntax

$result = $client->listFacetNames([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) to retrieve facet names from.

Result Syntax

[
    'FacetNames' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
FacetNames
Type: Array of strings

The names of facets that exist within the schema.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

Examples

Example 1: To list facet names

$result = $client->listFacetNames([
    'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
]);

Result syntax:

[
    'FacetNames' => [
        'Legal_Entity',
        'Organization',
        'node1',
        'node2',
        'nodex',
        'policyfacet',
    ],
]
$result = $client->listIncomingTypedLinks([/* ... */]);
$promise = $client->listIncomingTypedLinksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listIncomingTypedLinks([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'FilterAttributeRanges' => [
        [
            'AttributeName' => '<string>',
            'Range' => [ // REQUIRED
                'EndMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                'EndValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'StartMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                'StartValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'FilterTypedLink' => [
        'SchemaArn' => '<string>', // REQUIRED
        'TypedLinkName' => '<string>', // REQUIRED
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

The consistency level to execute the request at.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

FilterAttributeRanges
Type: Array of TypedLinkAttributeRange structures

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

FilterTypedLink
Type: TypedLinkSchemaAndFacetName structure

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose attributes will be listed.

Result Syntax

[
    'LinkSpecifiers' => [
        [
            'IdentityAttributeValues' => [
                [
                    'AttributeName' => '<string>',
                    'Value' => [
                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BooleanValue' => true || false,
                        'DatetimeValue' => <DateTime>,
                        'NumberValue' => '<string>',
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'SourceObjectReference' => [
                'Selector' => '<string>',
            ],
            'TargetObjectReference' => [
                'Selector' => '<string>',
            ],
            'TypedLinkFacet' => [
                'SchemaArn' => '<string>',
                'TypedLinkName' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LinkSpecifiers
Type: Array of TypedLinkSpecifier structures

Returns one or more typed link specifiers as output.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

FacetValidationException:

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

Examples

$result = $client->listIncomingTypedLinks([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'LinkSpecifiers' => [
        [
            'IdentityAttributeValues' => [
                [
                    'AttributeName' => '22',
                    'Value' => [
                        'BinaryValue' => <BLOB>,
                    ],
                ],
            ],
            'SourceObjectReference' => [
                'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
            ],
            'TargetObjectReference' => [
                'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
            ],
            'TypedLinkFacet' => [
                'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
                'TypedLinkName' => 'exampletypedlink8',
            ],
        ],
        [
            'IdentityAttributeValues' => [
                [
                    'AttributeName' => '22',
                    'Value' => [
                        'BinaryValue' => <BLOB>,
                    ],
                ],
            ],
            'SourceObjectReference' => [
                'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
            ],
            'TargetObjectReference' => [
                'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
            ],
            'TypedLinkFacet' => [
                'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
                'TypedLinkName' => 'exampletypedlink8',
            ],
        ],
        [
            'IdentityAttributeValues' => [
                [
                    'AttributeName' => '22',
                    'Value' => [
                        'BinaryValue' => <BLOB>,
                    ],
                ],
            ],
            'SourceObjectReference' => [
                'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
            ],
            'TargetObjectReference' => [
                'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
            ],
            'TypedLinkFacet' => [
                'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
                'TypedLinkName' => 'exampletypedlink8',
            ],
        ],
    ],
    'NextToken' => '',
]

ListIndex

$result = $client->listIndex([/* ... */]);
$promise = $client->listIndexAsync([/* ... */]);

Lists objects attached to the specified index.

Parameter Syntax

$result = $client->listIndex([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'IndexReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RangesOnIndexedValues' => [
        [
            'AttributeKey' => [
                'FacetName' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'SchemaArn' => '<string>', // REQUIRED
            ],
            'Range' => [
                'EndMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                'EndValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'StartMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                'StartValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

The consistency level to execute the request at.

DirectoryArn
Required: Yes
Type: string

The ARN of the directory that the index exists in.

IndexReference
Required: Yes
Type: ObjectReference structure

The reference to the index to list.

MaxResults
Type: int

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

NextToken
Type: string

The pagination token.

RangesOnIndexedValues
Type: Array of ObjectAttributeRange structures

Specifies the ranges of indexed values that you want to query.

Result Syntax

[
    'IndexAttachments' => [
        [
            'IndexedAttributes' => [
                [
                    'Key' => [
                        'FacetName' => '<string>',
                        'Name' => '<string>',
                        'SchemaArn' => '<string>',
                    ],
                    'Value' => [
                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BooleanValue' => true || false,
                        'DatetimeValue' => <DateTime>,
                        'NumberValue' => '<string>',
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'ObjectIdentifier' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
IndexAttachments
Type: Array of IndexAttachment structures

The objects and indexed values attached to the index.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

FacetValidationException:

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

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ResourceNotFoundException:

The specified resource could not be found.

NotIndexException:

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

Examples

Example 1: To list an index

$result = $client->listIndex([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'IndexReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q',
    ],
]);

Result syntax:

[
    'IndexAttachments' => [
        [
            'IndexedAttributes' => [
                [
                    'Key' => [
                        'FacetName' => 'Organization',
                        'Name' => 'description',
                        'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1',
                    ],
                    'Value' => [
                    ],
                ],
            ],
            'ObjectIdentifier' => 'AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
        ],
    ],
]

ListManagedSchemaArns

$result = $client->listManagedSchemaArns([/* ... */]);
$promise = $client->listManagedSchemaArnsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listManagedSchemaArns([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaArn' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

SchemaArn
Type: string

The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.

Result Syntax

[
    'NextToken' => '<string>',
    'SchemaArns' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

The pagination token.

SchemaArns
Type: Array of strings

The ARNs for all AWS managed schemas.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

ValidationException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ListObjectAttributes

$result = $client->listObjectAttributes([/* ... */]);
$promise = $client->listObjectAttributesAsync([/* ... */]);

Lists all attributes that are associated with an object.

Parameter Syntax

$result = $client->listObjectAttributes([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'FacetFilter' => [
        'FacetName' => '<string>',
        'SchemaArn' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

FacetFilter
Type: SchemaFacet structure

Used to filter the list of object attributes that are associated with a certain facet.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object whose attributes will be listed.

Result Syntax

[
    'Attributes' => [
        [
            'Key' => [
                'FacetName' => '<string>',
                'Name' => '<string>',
                'SchemaArn' => '<string>',
            ],
            'Value' => [
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Attributes
Type: Array of AttributeKeyAndValue structures

Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

FacetValidationException:

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

Examples

Example 1: To list object attributes

$result = $client->listObjectAttributes([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q',
    ],
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => [
                'FacetName' => 'INDEX',
                'Name' => 'index_is_unique',
                'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/CloudDirectory/1.0',
            ],
            'Value' => [
                'BooleanValue' => 1,
            ],
        ],
        [
            'Key' => [
                'FacetName' => 'INDEX',
                'Name' => 'ordered_indexed_attributes',
                'SchemaArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/CloudDirectory/1.0',
            ],
            'Value' => [
                'StringValue' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1*Organization*description',
            ],
        ],
    ],
]

ListObjectChildren

$result = $client->listObjectChildren([/* ... */]);
$promise = $client->listObjectChildrenAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listObjectChildren([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object for which child objects are being listed.

Result Syntax

[
    'Children' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
Children
Type: Associative array of custom strings keys (LinkName) to strings

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

NotNodeException:

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

Examples

Example 1: To list an objects children

$result = $client->listObjectChildren([
    'DirectoryArn' => 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY',
    'ObjectReference' => [
        'Selector' => '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw',
    ],
]);

Result syntax:

[
    'Children' => [
        'link2' => 'AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA',
    ],
]

ListObjectParentPaths

$result = $client->listObjectParentPaths([/* ... */]);
$promise = $client->listObjectParentPathsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listObjectParentPaths([
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory to which the parent path applies.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object whose parent paths are listed.

Result Syntax

[
    'NextToken' => '<string>',
    'PathToObjectIdentifiersList' => [
        [
            'ObjectIdentifiers' => ['<string>', ...],
            'Path' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token.

PathToObjectIdentifiersList
Type: Array of PathToObjectIdentifiers structures

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

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ResourceNotFoundException:

The specified resource could not be found.

ListObjectParents

$result = $client->listObjectParents([/* ... */]);
$promise = $client->listObjectParentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listObjectParents([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'IncludeAllLinksToEachParent' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

IncludeAllLinksToEachParent
Type: boolean

When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object for which parent objects are being listed.

Result Syntax

[
    'NextToken' => '<string>',
    'ParentLinks' => [
        [
            'LinkName' => '<string>',
            'ObjectIdentifier' => '<string>',
        ],
        // ...
    ],
    'Parents' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

The pagination token.

ParentLinks
Type: Array of ObjectIdentifierAndLinkNameTuple structures

Returns a list of parent reference and LinkName Tuples.

Parents
Type: Associative array of custom strings keys (ObjectIdentifier) to strings

The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

CannotListParentOfRootException:

Cannot list the parents of a Directory root.

ListObjectPolicies

$result = $client->listObjectPolicies([/* ... */]);
$promise = $client->listObjectPoliciesAsync([/* ... */]);

Returns policies attached to an object in pagination fashion.

Parameter Syntax

$result = $client->listObjectPolicies([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object for which policies will be listed.

Result Syntax

[
    'AttachedPolicyIds' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
AttachedPolicyIds
Type: Array of strings

A list of policy ObjectIdentifiers, that are attached to the object.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

$result = $client->listOutgoingTypedLinks([/* ... */]);
$promise = $client->listOutgoingTypedLinksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listOutgoingTypedLinks([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'FilterAttributeRanges' => [
        [
            'AttributeName' => '<string>',
            'Range' => [ // REQUIRED
                'EndMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                'EndValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'StartMode' => 'FIRST|LAST|LAST_BEFORE_MISSING_VALUES|INCLUSIVE|EXCLUSIVE', // REQUIRED
                'StartValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'FilterTypedLink' => [
        'SchemaArn' => '<string>', // REQUIRED
        'TypedLinkName' => '<string>', // REQUIRED
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

The consistency level to execute the request at.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

FilterAttributeRanges
Type: Array of TypedLinkAttributeRange structures

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

FilterTypedLink
Type: TypedLinkSchemaAndFacetName structure

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

A reference that identifies the object whose attributes will be listed.

Result Syntax

[
    'NextToken' => '<string>',
    'TypedLinkSpecifiers' => [
        [
            'IdentityAttributeValues' => [
                [
                    'AttributeName' => '<string>',
                    'Value' => [
                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BooleanValue' => true || false,
                        'DatetimeValue' => <DateTime>,
                        'NumberValue' => '<string>',
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'SourceObjectReference' => [
                'Selector' => '<string>',
            ],
            'TargetObjectReference' => [
                'Selector' => '<string>',
            ],
            'TypedLinkFacet' => [
                'SchemaArn' => '<string>',
                'TypedLinkName' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token.

TypedLinkSpecifiers
Type: Array of TypedLinkSpecifier structures

Returns a typed link specifier as output.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

FacetValidationException:

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

ListPolicyAttachments

$result = $client->listPolicyAttachments([/* ... */]);
$promise = $client->listPolicyAttachmentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPolicyAttachments([
    'ConsistencyLevel' => 'SERIALIZABLE|EVENTUAL',
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PolicyReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
ConsistencyLevel
Type: string

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

PolicyReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the policy object.

Result Syntax

[
    'NextToken' => '<string>',
    'ObjectIdentifiers' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

The pagination token.

ObjectIdentifiers
Type: Array of strings

A list of ObjectIdentifiers to which the policy is attached.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ResourceNotFoundException:

The specified resource could not be found.

NotPolicyException:

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

ListPublishedSchemaArns

$result = $client->listPublishedSchemaArns([/* ... */]);
$promise = $client->listPublishedSchemaArnsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listPublishedSchemaArns([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaArn' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

SchemaArn
Type: string

The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

Result Syntax

[
    'NextToken' => '<string>',
    'SchemaArns' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

The pagination token.

SchemaArns
Type: Array of strings

The ARNs of published schemas.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

NextToken
Type: string

The pagination token. This is for future use. Currently pagination is not supported for tagging.

ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Tags
Type: Array of Tag structures

A list of tag key value pairs that are associated with the response.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidTaggingRequestException:

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.

ListTypedLinkFacetAttributes

$result = $client->listTypedLinkFacetAttributes([/* ... */]);
$promise = $client->listTypedLinkFacetAttributesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTypedLinkFacetAttributes([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

Name
Required: Yes
Type: string

The unique name of the typed link facet.

NextToken
Type: string

The pagination token.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Result Syntax

[
    'Attributes' => [
        [
            'DefaultValue' => [
                'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BooleanValue' => true || false,
                'DatetimeValue' => <DateTime>,
                'NumberValue' => '<string>',
                'StringValue' => '<string>',
            ],
            'IsImmutable' => true || false,
            'Name' => '<string>',
            'RequiredBehavior' => 'REQUIRED_ALWAYS|NOT_REQUIRED',
            'Rules' => [
                '<RuleKey>' => [
                    'Parameters' => ['<string>', ...],
                    'Type' => 'BINARY_LENGTH|NUMBER_COMPARISON|STRING_FROM_SET|STRING_LENGTH',
                ],
                // ...
            ],
            'Type' => 'STRING|BINARY|BOOLEAN|NUMBER|DATETIME|VARIANT',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Attributes
Type: Array of TypedLinkAttributeDefinition structures

An ordered set of attributes associate with the typed link.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ListTypedLinkFacetNames

$result = $client->listTypedLinkFacetNames([/* ... */]);
$promise = $client->listTypedLinkFacetNamesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTypedLinkFacetNames([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Result Syntax

[
    'FacetNames' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
FacetNames
Type: Array of strings

The names of typed link facets that exist within the schema.

NextToken
Type: string

The pagination token.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

LookupPolicy

$result = $client->lookupPolicy([/* ... */]);
$promise = $client->lookupPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->lookupPolicy([
    'DirectoryArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The token to request the next page of results.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose policies will be looked up.

Result Syntax

[
    'NextToken' => '<string>',
    'PolicyToPathList' => [
        [
            'Path' => '<string>',
            'Policies' => [
                [
                    'ObjectIdentifier' => '<string>',
                    'PolicyId' => '<string>',
                    'PolicyType' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token.

PolicyToPathList
Type: Array of PolicyToPath structures

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ResourceNotFoundException:

The specified resource could not be found.

PublishSchema

$result = $client->publishSchema([/* ... */]);
$promise = $client->publishSchemaAsync([/* ... */]);

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

Parameter Syntax

$result = $client->publishSchema([
    'DevelopmentSchemaArn' => '<string>', // REQUIRED
    'MinorVersion' => '<string>',
    'Name' => '<string>',
    'Version' => '<string>', // REQUIRED
]);

Parameter Details

Members
DevelopmentSchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.

MinorVersion
Type: string

The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

Name
Type: string

The new name under which the schema will be published. If this is not provided, the development schema is considered.

Version
Required: Yes
Type: string

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

Result Syntax

[
    'PublishedSchemaArn' => '<string>',
]

Result Details

Members
PublishedSchemaArn
Type: string

The ARN that is associated with the published schema. For more information, see arns.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

SchemaAlreadyPublishedException:

Indicates that a schema is already published.

PutSchemaFromJson

$result = $client->putSchemaFromJson([/* ... */]);
$promise = $client->putSchemaFromJsonAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putSchemaFromJson([
    'Document' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Document
Required: Yes
Type: string

The replacement JSON schema.

SchemaArn
Required: Yes
Type: string

The ARN of the schema to update.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

The ARN of the schema to update.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

InvalidSchemaDocException:

Indicates that the provided SchemaDoc value is not valid.

InvalidRuleException:

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

RemoveFacetFromObject

$result = $client->removeFacetFromObject([/* ... */]);
$promise = $client->removeFacetFromObjectAsync([/* ... */]);

Removes the specified facet from the specified object.

Parameter Syntax

$result = $client->removeFacetFromObject([
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
    'SchemaFacet' => [ // REQUIRED
        'FacetName' => '<string>',
        'SchemaArn' => '<string>',
    ],
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN of the directory in which the object resides.

ObjectReference
Required: Yes
Type: ObjectReference structure

A reference to the object to remove the facet from.

SchemaFacet
Required: Yes
Type: SchemaFacet structure

The facet to remove. See SchemaFacet for details.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

An API operation for adding tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

Tags
Required: Yes
Type: Array of Tag structures

A list of tag key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidTaggingRequestException:

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.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

An API operation for removing tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

TagKeys
Required: Yes
Type: Array of strings

Keys of the tag that need to be removed from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidTaggingRequestException:

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.

UpdateFacet

$result = $client->updateFacet([/* ... */]);
$promise = $client->updateFacetAsync([/* ... */]);

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

Parameter Syntax

$result = $client->updateFacet([
    'AttributeUpdates' => [
        [
            'Action' => 'CREATE_OR_UPDATE|DELETE',
            'Attribute' => [
                'AttributeDefinition' => [
                    'DefaultValue' => [
                        'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BooleanValue' => true || false,
                        'DatetimeValue' => <integer || string || DateTime>,
                        'NumberValue' => '<string>',
                        'StringValue' => '<string>',
                    ],
                    'IsImmutable' => true || false,
                    'Rules' => [
                        '<RuleKey>' => [
                            'Parameters' => ['<string>', ...],
                            'Type' => 'BINARY_LENGTH|NUMBER_COMPARISON|STRING_FROM_SET|STRING_LENGTH',
                        ],
                        // ...
                    ],
                    'Type' => 'STRING|BINARY|BOOLEAN|NUMBER|DATETIME|VARIANT', // REQUIRED
                ],
                'AttributeReference' => [
                    'TargetAttributeName' => '<string>', // REQUIRED
                    'TargetFacetName' => '<string>', // REQUIRED
                ],
                'Name' => '<string>', // REQUIRED
                'RequiredBehavior' => 'REQUIRED_ALWAYS|NOT_REQUIRED',
            ],
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'ObjectType' => 'NODE|LEAF_NODE|POLICY|INDEX',
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AttributeUpdates
Type: Array of FacetAttributeUpdate structures

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

Name
Required: Yes
Type: string

The name of the facet.

ObjectType
Type: string

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

InvalidFacetUpdateException:

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

FacetValidationException:

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

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

InvalidRuleException:

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

UpdateLinkAttributes

$result = $client->updateLinkAttributes([/* ... */]);
$promise = $client->updateLinkAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateLinkAttributes([
    'AttributeUpdates' => [ // REQUIRED
        [
            'AttributeAction' => [
                'AttributeActionType' => 'CREATE_OR_UPDATE|DELETE',
                'AttributeUpdateValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
            'AttributeKey' => [
                'FacetName' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'SchemaArn' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'DirectoryArn' => '<string>', // REQUIRED
    'TypedLinkSpecifier' => [ // REQUIRED
        'IdentityAttributeValues' => [ // REQUIRED
            [
                'AttributeName' => '<string>', // REQUIRED
                'Value' => [ // REQUIRED
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
            // ...
        ],
        'SourceObjectReference' => [ // REQUIRED
            'Selector' => '<string>',
        ],
        'TargetObjectReference' => [ // REQUIRED
            'Selector' => '<string>',
        ],
        'TypedLinkFacet' => [ // REQUIRED
            'SchemaArn' => '<string>', // REQUIRED
            'TypedLinkName' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
AttributeUpdates
Required: Yes
Type: Array of LinkAttributeUpdate structures

The attributes update structure.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links.

TypedLinkSpecifier
Required: Yes
Type: TypedLinkSpecifier structure

Allows a typed link specifier to be accepted as input.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

FacetValidationException:

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

UpdateObjectAttributes

$result = $client->updateObjectAttributes([/* ... */]);
$promise = $client->updateObjectAttributesAsync([/* ... */]);

Updates a given object's attributes.

Parameter Syntax

$result = $client->updateObjectAttributes([
    'AttributeUpdates' => [ // REQUIRED
        [
            'ObjectAttributeAction' => [
                'ObjectAttributeActionType' => 'CREATE_OR_UPDATE|DELETE',
                'ObjectAttributeUpdateValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
            ],
            'ObjectAttributeKey' => [
                'FacetName' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'SchemaArn' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'DirectoryArn' => '<string>', // REQUIRED
    'ObjectReference' => [ // REQUIRED
        'Selector' => '<string>',
    ],
]);

Parameter Details

Members
AttributeUpdates
Required: Yes
Type: Array of ObjectAttributeUpdate structures

The attributes update structure.

DirectoryArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object.

Result Syntax

[
    'ObjectIdentifier' => '<string>',
]

Result Details

Members
ObjectIdentifier
Type: string

The ObjectIdentifier of the updated object.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

DirectoryNotEnabledException:

Operations are only permitted on enabled directories.

ResourceNotFoundException:

The specified resource could not be found.

LinkNameAlreadyInUseException:

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

FacetValidationException:

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

UpdateSchema

$result = $client->updateSchema([/* ... */]);
$promise = $client->updateSchemaAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateSchema([
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the schema.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

Result Syntax

[
    'SchemaArn' => '<string>',
]

Result Details

Members
SchemaArn
Type: string

The ARN that is associated with the updated schema. For more information, see arns.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

UpdateTypedLinkFacet

$result = $client->updateTypedLinkFacet([/* ... */]);
$promise = $client->updateTypedLinkFacetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateTypedLinkFacet([
    'AttributeUpdates' => [ // REQUIRED
        [
            'Action' => 'CREATE_OR_UPDATE|DELETE', // REQUIRED
            'Attribute' => [ // REQUIRED
                'DefaultValue' => [
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BooleanValue' => true || false,
                    'DatetimeValue' => <integer || string || DateTime>,
                    'NumberValue' => '<string>',
                    'StringValue' => '<string>',
                ],
                'IsImmutable' => true || false,
                'Name' => '<string>', // REQUIRED
                'RequiredBehavior' => 'REQUIRED_ALWAYS|NOT_REQUIRED', // REQUIRED
                'Rules' => [
                    '<RuleKey>' => [
                        'Parameters' => ['<string>', ...],
                        'Type' => 'BINARY_LENGTH|NUMBER_COMPARISON|STRING_FROM_SET|STRING_LENGTH',
                    ],
                    // ...
                ],
                'Type' => 'STRING|BINARY|BOOLEAN|NUMBER|DATETIME|VARIANT', // REQUIRED
            ],
        ],
        // ...
    ],
    'IdentityAttributeOrder' => ['<string>', ...], // REQUIRED
    'Name' => '<string>', // REQUIRED
    'SchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AttributeUpdates
Required: Yes
Type: Array of TypedLinkFacetAttributeUpdate structures

Attributes update structure.

IdentityAttributeOrder
Required: Yes
Type: Array of strings

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

Name
Required: Yes
Type: string

The unique name of the typed link facet.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

LimitExceededException:

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

AccessDeniedException:

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.

FacetValidationException:

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

InvalidFacetUpdateException:

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

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

InvalidRuleException:

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

UpgradeAppliedSchema

$result = $client->upgradeAppliedSchema([/* ... */]);
$promise = $client->upgradeAppliedSchemaAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->upgradeAppliedSchema([
    'DirectoryArn' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'PublishedSchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryArn
Required: Yes
Type: string

The ARN for the directory to which the upgraded schema will be applied.

DryRun
Type: boolean

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

PublishedSchemaArn
Required: Yes
Type: string

The revision of the published schema to upgrade the directory to.

Result Syntax

[
    'DirectoryArn' => '<string>',
    'UpgradedSchemaArn' => '<string>',
]

Result Details

Members
DirectoryArn
Type: string

The ARN of the directory that is returned as part of the response.

UpgradedSchemaArn
Type: string

The ARN of the upgraded schema that is returned as part of the response.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

IncompatibleSchemaException:

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.

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidAttachmentException:

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.

SchemaAlreadyExistsException:

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

UpgradePublishedSchema

$result = $client->upgradePublishedSchema([/* ... */]);
$promise = $client->upgradePublishedSchemaAsync([/* ... */]);

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

Parameter Syntax

$result = $client->upgradePublishedSchema([
    'DevelopmentSchemaArn' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'MinorVersion' => '<string>', // REQUIRED
    'PublishedSchemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DevelopmentSchemaArn
Required: Yes
Type: string

The ARN of the development schema with the changes used for the upgrade.

DryRun
Type: boolean

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

MinorVersion
Required: Yes
Type: string

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

PublishedSchemaArn
Required: Yes
Type: string

The ARN of the published schema to be upgraded.

Result Syntax

[
    'UpgradedSchemaArn' => '<string>',
]

Result Details

Members
UpgradedSchemaArn
Type: string

The ARN of the upgraded schema that is returned as part of the response.

Errors

InternalServiceException:

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.

InvalidArnException:

Indicates that the provided ARN value is not valid.

RetryableConflictException:

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.

ValidationException:

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

IncompatibleSchemaException:

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.

AccessDeniedException:

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.

ResourceNotFoundException:

The specified resource could not be found.

InvalidAttachmentException:

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.

LimitExceededException:

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

Shapes

AccessDeniedException

Description

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.

Members
Message
Type: string

AttributeKey

Description

A unique identifier for an attribute.

Members
FacetName
Required: Yes
Type: string

The name of the facet that the attribute exists within.

Name
Required: Yes
Type: string

The name of the attribute.

SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

AttributeKeyAndValue

Description

The combination of an attribute key and an attribute value.

Members
Key
Required: Yes
Type: AttributeKey structure

The key of the attribute.

Value
Required: Yes
Type: TypedAttributeValue structure

The value of the attribute.

AttributeNameAndValue

Description

Identifies the attribute name and value for a typed link.

Members
AttributeName
Required: Yes
Type: string

The attribute name of the typed link.

Value
Required: Yes
Type: TypedAttributeValue structure

The value for the typed link.

BatchAddFacetToObject

Description

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

Members
ObjectAttributeList
Required: Yes
Type: Array of AttributeKeyAndValue structures

The attributes to set on the object.

ObjectReference
Required: Yes
Type: ObjectReference structure

A reference to the object being mutated.

SchemaFacet
Required: Yes
Type: SchemaFacet structure

Represents the facet being added to the object.

BatchAddFacetToObjectResponse

Description

The result of a batch add facet to object operation.

Members

BatchAttachObject

Description

Represents the output of an AttachObject operation.

Members
ChildReference
Required: Yes
Type: ObjectReference structure

The child object reference that is to be attached to the object.

LinkName
Required: Yes
Type: string

The name of the link.

ParentReference
Required: Yes
Type: ObjectReference structure

The parent object reference.

BatchAttachObjectResponse

Description

Represents the output batch AttachObject response operation.

Members
attachedObjectIdentifier
Type: string

The ObjectIdentifier of the object that has been attached.

BatchAttachPolicy

Description

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

Members
ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object to which the policy will be attached.

PolicyReference
Required: Yes
Type: ObjectReference structure

The reference that is associated with the policy object.

BatchAttachPolicyResponse

Description

Represents the output of an AttachPolicy response operation.

Members

BatchAttachToIndex

Description

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

Members
IndexReference
Required: Yes
Type: ObjectReference structure

A reference to the index that you are attaching the object to.

TargetReference
Required: Yes
Type: ObjectReference structure

A reference to the object that you are attaching to the index.

BatchAttachToIndexResponse

Description

Represents the output of a AttachToIndex response operation.

Members
AttachedObjectIdentifier
Type: string

The ObjectIdentifier of the object that was attached to the index.

Description

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

Members
Attributes
Required: Yes
Type: Array of AttributeNameAndValue structures

A set of attributes that are associated with the typed link.

SourceObjectReference
Required: Yes
Type: ObjectReference structure

Identifies the source object that the typed link will attach to.

TargetObjectReference
Required: Yes
Type: ObjectReference structure

Identifies the target object that the typed link will attach to.

TypedLinkFacet
Required: Yes
Type: TypedLinkSchemaAndFacetName structure

Identifies the typed link facet that is associated with the typed link.

BatchAttachTypedLinkResponse

Description

Represents the output of a AttachTypedLink response operation.

Members
TypedLinkSpecifier
Type: TypedLinkSpecifier structure

Returns a typed link specifier as output.

BatchCreateIndex

Description

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

Members
BatchReferenceName
Type: string

The batch reference name. See Transaction Support for more information.

IsUnique
Required: Yes
Type: boolean

Indicates whether the attribute that is being indexed has unique values or not.

LinkName
Type: string

The name of the link between the parent object and the index object.

OrderedIndexedAttributeList
Required: Yes
Type: Array of AttributeKey structures

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

ParentReference
Type: ObjectReference structure

A reference to the parent object that contains the index object.

BatchCreateIndexResponse

Description

Represents the output of a CreateIndex response operation.

Members
ObjectIdentifier
Type: string

The ObjectIdentifier of the index created by this operation.

BatchCreateObject

Description

Represents the output of a CreateObject operation.

Members
BatchReferenceName
Type: string

The batch reference name. See Transaction Support for more information.

LinkName
Type: string

The name of the link.

ObjectAttributeList
Required: Yes
Type: Array of AttributeKeyAndValue structures

An attribute map, which contains an attribute ARN as the key and attribute value as the map value.

ParentReference
Type: ObjectReference structure

If specified, the parent reference to which this object will be attached.

SchemaFacet
Required: Yes
Type: Array of SchemaFacet structures

A list of FacetArns that will be associated with the object. For more information, see arns.

BatchCreateObjectResponse

Description

Represents the output of a CreateObject response operation.

Members
ObjectIdentifier
Type: string

The ID that is associated with the object.

BatchDeleteObject

Description

Represents the output of a DeleteObject operation.

Members
ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object.

BatchDeleteObjectResponse

Description

Represents the output of a DeleteObject response operation.

Members

BatchDetachFromIndex

Description

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

Members
IndexReference
Required: Yes
Type: ObjectReference structure

A reference to the index object.

TargetReference
Required: Yes
Type: ObjectReference structure

A reference to the object being detached from the index.

BatchDetachFromIndexResponse

Description

Represents the output of a DetachFromIndex response operation.

Members
DetachedObjectIdentifier
Type: string

The ObjectIdentifier of the object that was detached from the index.

BatchDetachObject

Description

Represents the output of a DetachObject operation.

Members
BatchReferenceName
Type: string

The batch reference name. See Transaction Support for more information.

LinkName
Required: Yes
Type: string

The name of the link.

ParentReference
Required: Yes
Type: ObjectReference structure

Parent reference from which the object with the specified link name is detached.

BatchDetachObjectResponse

Description

Represents the output of a DetachObject response operation.

Members
detachedObjectIdentifier
Type: string

The ObjectIdentifier of the detached object.

BatchDetachPolicy

Description

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

Members
ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose policy object will be detached.

PolicyReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the policy object.

BatchDetachPolicyResponse

Description

Represents the output of a DetachPolicy response operation.

Members

BatchDetachTypedLinkResponse

Description

Represents the output of a DetachTypedLink response operation.

Members

BatchGetLinkAttributes

Description

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

Members
AttributeNames
Required: Yes
Type: Array of strings

A list of attribute names whose values will be retrieved.

TypedLinkSpecifier
Required: Yes
Type: TypedLinkSpecifier structure

Allows a typed link specifier to be accepted as input.

BatchGetLinkAttributesResponse

Description

Represents the output of a GetLinkAttributes response operation.

Members
Attributes
Type: Array of AttributeKeyAndValue structures

The attributes that are associated with the typed link.

BatchGetObjectAttributes

Description

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

Members
AttributeNames
Required: Yes
Type: Array of strings

List of attribute names whose values will be retrieved.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose attributes will be retrieved.

SchemaFacet
Required: Yes
Type: SchemaFacet structure

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

BatchGetObjectAttributesResponse

Description

Represents the output of a GetObjectAttributes response operation.

Members
Attributes
Type: Array of AttributeKeyAndValue structures

The attribute values that are associated with an object.

BatchGetObjectInformationResponse

Description

Represents the output of a GetObjectInformation response operation.

Members
ObjectIdentifier
Type: string

The ObjectIdentifier of the specified object.

SchemaFacets
Type: Array of SchemaFacet structures

The facets attached to the specified object.

BatchListAttachedIndices

Description

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

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

TargetReference
Required: Yes
Type: ObjectReference structure

A reference to the object that has indices attached.

BatchListAttachedIndicesResponse

Description

Represents the output of a ListAttachedIndices response operation.

Members
IndexAttachments
Type: Array of IndexAttachment structures

The indices attached to the specified object.

NextToken
Type: string

The pagination token.

Description

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.

Members
FilterAttributeRanges
Type: Array of TypedLinkAttributeRange structures

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

FilterTypedLink
Type: TypedLinkSchemaAndFacetName structure

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object whose attributes will be listed.

BatchListIncomingTypedLinksResponse

Description

Represents the output of a ListIncomingTypedLinks response operation.

Members
LinkSpecifiers
Type: Array of TypedLinkSpecifier structures

Returns one or more typed link specifiers as output.

NextToken
Type: string

The pagination token.

BatchListIndex

Description

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

Members
IndexReference
Required: Yes
Type: ObjectReference structure

The reference to the index to list.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

RangesOnIndexedValues
Type: Array of ObjectAttributeRange structures

Specifies the ranges of indexed values that you want to query.

BatchListIndexResponse

Description

Represents the output of a ListIndex response operation.

Members
IndexAttachments
Type: Array of IndexAttachment structures

The objects and indexed values attached to the index.

NextToken
Type: string

The pagination token.

BatchListObjectAttributes

Description

Represents the output of a ListObjectAttributes operation.

Members
FacetFilter
Type: SchemaFacet structure

Used to filter the list of object attributes that are associated with a certain facet.

MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference of the object whose attributes need to be listed.

BatchListObjectAttributesResponse

Description

Represents the output of a ListObjectAttributes response operation.

Members
Attributes
Type: Array of AttributeKeyAndValue structures

The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value.

NextToken
Type: string

The pagination token.

BatchListObjectChildren

Description

Represents the output of a ListObjectChildren operation.

Members
MaxResults
Type: int

Maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference of the object for which child objects are being listed.

BatchListObjectChildrenResponse

Description

Represents the output of a ListObjectChildren response operation.

Members
Children
Type: Associative array of custom strings keys (LinkName) to strings

The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value.

NextToken
Type: string

The pagination token.

BatchListObjectParentPaths

Description

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.

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object whose attributes will be listed.

BatchListObjectParentPathsResponse

Description

Represents the output of a ListObjectParentPaths response operation.

Members
NextToken
Type: string

The pagination token.

PathToObjectIdentifiersList
Type: Array of PathToObjectIdentifiers structures

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

BatchListObjectParents

Description

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

Members
MaxResults
Type: int

The maximum number of items to be retrieved in a single call. This is an approximate number.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies an object.

BatchListObjectParentsResponse

Description

Represents the output of a ListObjectParents response operation.

Members
NextToken
Type: string

The pagination token.

ParentLinks
Type: Array of ObjectIdentifierAndLinkNameTuple structures

Returns a list of parent reference and LinkName Tuples.

BatchListObjectPolicies

Description

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

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object whose attributes will be listed.

BatchListObjectPoliciesResponse

Description

Represents the output of a ListObjectPolicies response operation.

Members
AttachedPolicyIds
Type: Array of strings

A list of policy ObjectIdentifiers, that are attached to the object.

NextToken
Type: string

The pagination token.

Description

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.

Members
FilterAttributeRanges
Type: Array of TypedLinkAttributeRange structures

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

FilterTypedLink
Type: TypedLinkSchemaAndFacetName structure

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the object whose attributes will be listed.

BatchListOutgoingTypedLinksResponse

Description

Represents the output of a ListOutgoingTypedLinks response operation.

Members
NextToken
Type: string

The pagination token.

TypedLinkSpecifiers
Type: Array of TypedLinkSpecifier structures

Returns a typed link specifier as output.

BatchListPolicyAttachments

Description

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

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

PolicyReference
Required: Yes
Type: ObjectReference structure

The reference that identifies the policy object.

BatchListPolicyAttachmentsResponse

Description

Represents the output of a ListPolicyAttachments response operation.

Members
NextToken
Type: string

The pagination token.

ObjectIdentifiers
Type: Array of strings

A list of ObjectIdentifiers to which the policy is attached.

BatchLookupPolicy

Description

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.

Members
MaxResults
Type: int

The maximum number of results to retrieve.

NextToken
Type: string

The pagination token.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object whose policies will be looked up.

BatchLookupPolicyResponse

Description

Represents the output of a LookupPolicy response operation.

Members
NextToken
Type: string

The pagination token.

PolicyToPathList
Type: Array of PolicyToPath structures

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

BatchReadException

Description

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

Members
Message
Type: string

An exception message that is associated with the failure.

Type
Type: string

A type of exception, such as InvalidArnException.

BatchReadOperation

Description

Represents the output of a BatchRead operation.

Members
GetLinkAttributes
Type: BatchGetLinkAttributes structure

Retrieves attributes that are associated with a typed link.

GetObjectAttributes
Type: BatchGetObjectAttributes structure

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

GetObjectInformation
Type: BatchGetObjectInformation structure

Retrieves metadata about an object.

ListAttachedIndices
Type: BatchListAttachedIndices structure

Lists indices attached to an object.

ListIncomingTypedLinks
Type: BatchListIncomingTypedLinks structure

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
Type: BatchListIndex structure

Lists objects attached to the specified index.

ListObjectAttributes
Type: BatchListObjectAttributes structure

Lists all attributes that are associated with an object.

ListObjectChildren
Type: BatchListObjectChildren structure

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

ListObjectParentPaths
Type: BatchListObjectParentPaths structure

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.

ListObjectParents
Type: BatchListObjectParents structure

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

ListObjectPolicies
Type: BatchListObjectPolicies structure

Returns policies attached to an object in pagination fashion.

ListOutgoingTypedLinks
Type: BatchListOutgoingTypedLinks structure

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
Type: BatchListPolicyAttachments structure

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

LookupPolicy
Type: BatchLookupPolicy structure

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.

BatchReadOperationResponse

Description

Represents the output of a BatchRead response operation.

Members
ExceptionResponse
Type: BatchReadException structure

Identifies which operation in a batch has failed.

SuccessfulResponse
Type: BatchReadSuccessfulResponse structure

Identifies which operation in a batch has succeeded.

BatchReadSuccessfulResponse

Description

Represents the output of a BatchRead success response operation.

Members
GetLinkAttributes

The list of attributes to retrieve from the typed link.

GetObjectAttributes

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

GetObjectInformation

Retrieves metadata about an object.

ListAttachedIndices

Lists indices attached to an object.

ListIncomingTypedLinks

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
Type: BatchListIndexResponse structure

Lists objects attached to the specified index.

ListObjectAttributes

Lists all attributes that are associated with an object.

ListObjectChildren

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

ListObjectParentPaths

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.

ListObjectParents

The list of parent objects to retrieve.

ListObjectPolicies

Returns policies attached to an object in pagination fashion.

ListOutgoingTypedLinks

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

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

LookupPolicy
Type: BatchLookupPolicyResponse structure

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.

BatchRemoveFacetFromObject

Description

A batch operation to remove a facet from an object.

Members
ObjectReference
Required: Yes
Type: ObjectReference structure

A reference to the object whose facet will be removed.

SchemaFacet
Required: Yes
Type: SchemaFacet structure

The facet to remove from the object.

BatchRemoveFacetFromObjectResponse

Description

An empty result that represents success.

Members

BatchUpdateLinkAttributes

Description

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.

Members
AttributeUpdates
Required: Yes
Type: Array of LinkAttributeUpdate structures

The attributes update structure.

TypedLinkSpecifier
Required: Yes
Type: TypedLinkSpecifier structure

Allows a typed link specifier to be accepted as input.

BatchUpdateLinkAttributesResponse

Description

Represents the output of a UpdateLinkAttributes response operation.

Members

BatchUpdateObjectAttributes

Description

Represents the output of a BatchUpdate operation.

Members
AttributeUpdates
Required: Yes
Type: Array of ObjectAttributeUpdate structures

Attributes update structure.

ObjectReference
Required: Yes
Type: ObjectReference structure

Reference that identifies the object.

BatchUpdateObjectAttributesResponse

Description

Represents the output of a BatchUpdate response operation.

Members
ObjectIdentifier
Type: string

ID that is associated with the object.

BatchWriteException

Description

A BatchWrite exception has occurred.

Members
Index
Type: int
Message
Type: string
Type
Type: string

BatchWriteOperation

Description

Represents the output of a BatchWrite operation.

Members
AddFacetToObject
Type: BatchAddFacetToObject structure

A batch operation that adds a facet to an object.

AttachObject
Type: BatchAttachObject structure

Attaches an object to a Directory.

AttachPolicy
Type: BatchAttachPolicy structure

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

AttachToIndex
Type: BatchAttachToIndex structure

Attaches the specified object to the specified index.

AttachTypedLink
Type: BatchAttachTypedLink structure

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

CreateIndex
Type: BatchCreateIndex structure

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

CreateObject
Type: BatchCreateObject structure

Creates an object.

DeleteObject
Type: BatchDeleteObject structure

Deletes an object in a Directory.

DetachFromIndex
Type: BatchDetachFromIndex structure

Detaches the specified object from the specified index.

DetachObject
Type: BatchDetachObject structure

Detaches an object from a Directory.

DetachPolicy
Type: BatchDetachPolicy structure

Detaches a policy from a Directory.

DetachTypedLink
Type: BatchDetachTypedLink structure

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

RemoveFacetFromObject
Type: BatchRemoveFacetFromObject structure

A batch operation that removes a facet from an object.

UpdateLinkAttributes
Type: BatchUpdateLinkAttributes structure

Updates a given object's attributes.

UpdateObjectAttributes
Type: BatchUpdateObjectAttributes structure

Updates a given object's attributes.

BatchWriteOperationResponse

Description

Represents the output of a BatchWrite response operation.

Members
AddFacetToObject

The result of an add facet to object batch operation.

AttachObject
Type: BatchAttachObjectResponse structure

Attaches an object to a Directory.

AttachPolicy
Type: BatchAttachPolicyResponse structure

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

AttachToIndex
Type: BatchAttachToIndexResponse structure

Attaches the specified object to the specified index.

AttachTypedLink

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

CreateIndex
Type: BatchCreateIndexResponse structure

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

CreateObject
Type: BatchCreateObjectResponse structure

Creates an object in a Directory.

DeleteObject
Type: BatchDeleteObjectResponse structure

Deletes an object in a Directory.

DetachFromIndex

Detaches the specified object from the specified index.

DetachObject
Type: BatchDetachObjectResponse structure

Detaches an object from a Directory.

DetachPolicy
Type: BatchDetachPolicyResponse structure

Detaches a policy from a Directory.

DetachTypedLink

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

RemoveFacetFromObject

The result of a batch remove facet from object operation.

UpdateLinkAttributes

Represents the output of a BatchWrite response operation.

UpdateObjectAttributes

Updates a given object’s attributes.

CannotListParentOfRootException

Description

Cannot list the parents of a Directory root.

Members
Message
Type: string

Directory

Description

Directory structure that includes the directory name and directory ARN.

Members
CreationDateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the directory was created.

DirectoryArn
Type: string

The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.

Name
Type: string

The name of the directory.

State
Type: string

The state of the directory. Can be either Enabled, Disabled, or Deleted.

DirectoryAlreadyExistsException

Description

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

Members
Message
Type: string

DirectoryDeletedException

Description

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

Members
Message
Type: string

DirectoryNotDisabledException

Description

An operation can only operate on a disabled directory.

Members
Message
Type: string

DirectoryNotEnabledException

Description

Operations are only permitted on enabled directories.

Members
Message
Type: string

Facet

Description

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

Members
FacetStyle
Type: string

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

Name
Type: string

The name of the Facet.

ObjectType
Type: string

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

FacetAlreadyExistsException

Description

A facet with the same name already exists.

Members
Message
Type: string

FacetAttribute

Description

An attribute that is associated with the Facet.

Members
AttributeDefinition
Type: FacetAttributeDefinition structure

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

AttributeReference
Type: FacetAttributeReference structure

An attribute reference that is associated with the attribute. See Attribute References for more information.

Name
Required: Yes
Type: string

The name of the facet attribute.

RequiredBehavior
Type: string

The required behavior of the FacetAttribute.

FacetAttributeDefinition

Description

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

Members
DefaultValue
Type: TypedAttributeValue structure

The default value of the attribute (if configured).

IsImmutable
Type: boolean

Whether the attribute is mutable or not.

Rules
Type: Associative array of custom strings keys (RuleKey) to Rule structures

Validation rules attached to the attribute definition.

Type
Required: Yes
Type: string

The type of the attribute.

FacetAttributeReference

Description

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

Members
TargetAttributeName
Required: Yes
Type: string

The target attribute name that is associated with the facet reference. See Attribute References for more information.

TargetFacetName
Required: Yes
Type: string

The target facet name that is associated with the facet reference. See Attribute References for more information.

FacetAttributeUpdate

Description

A structure that contains information used to update an attribute.

Members
Action
Type: string

The action to perform when updating the attribute.

Attribute
Type: FacetAttribute structure

The attribute to update.

FacetInUseException

Description

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

Members
Message
Type: string

FacetNotFoundException

Description

The specified Facet could not be found.

Members
Message
Type: string

FacetValidationException

Description

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

Members
Message
Type: string

IncompatibleSchemaException

Description

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.

Members
Message
Type: string

IndexAttachment

Description

Represents an index and an attached object.

Members
IndexedAttributes
Type: Array of AttributeKeyAndValue structures

The indexed attribute values.

ObjectIdentifier
Type: string

In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

IndexedAttributeMissingException

Description

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

Members
Message
Type: string

InternalServiceException

Description

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.

Members
Message
Type: string

InvalidArnException

Description

Indicates that the provided ARN value is not valid.

Members
Message
Type: string

InvalidAttachmentException

Description

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.

Members
Message
Type: string

InvalidFacetUpdateException

Description

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

Members
Message
Type: string

InvalidNextTokenException

Description

Indicates that the NextToken value is not valid.

Members
Message
Type: string

InvalidRuleException

Description

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

Members
Message
Type: string

InvalidSchemaDocException

Description

Indicates that the provided SchemaDoc value is not valid.

Members
Message
Type: string

InvalidTaggingRequestException

Description

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.

Members
Message
Type: string

LimitExceededException

Description

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

Members
Message
Type: string

LinkAttributeAction

Description

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

Members
AttributeActionType
Type: string

A type that can be either UPDATE_OR_CREATE or DELETE.

AttributeUpdateValue
Type: TypedAttributeValue structure

The value that you want to update to.

LinkAttributeUpdate

Description

Structure that contains attribute update information.

Members
AttributeAction
Type: LinkAttributeAction structure

The action to perform as part of the attribute update.

AttributeKey
Type: AttributeKey structure

The key of the attribute being updated.

LinkNameAlreadyInUseException

Description

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

Members
Message
Type: string

NotIndexException

Description

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

Members
Message
Type: string

NotNodeException

Description

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

Members
Message
Type: string

NotPolicyException

Description

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

Members
Message
Type: string

ObjectAlreadyDetachedException

Description

Indicates that the object is not attached to the index.

Members
Message
Type: string

ObjectAttributeAction

Description

The action to take on the object attribute.

Members
ObjectAttributeActionType
Type: string

A type that can be either Update or Delete.

ObjectAttributeUpdateValue
Type: TypedAttributeValue structure

The value that you want to update to.

ObjectAttributeRange

Description

A range of attributes.

Members
AttributeKey
Type: AttributeKey structure

The key of the attribute that the attribute range covers.

Range
Type: TypedAttributeValueRange structure

The range of attribute values being selected.

ObjectAttributeUpdate

Description

Structure that contains attribute update information.

Members
ObjectAttributeAction
Type: ObjectAttributeAction structure

The action to perform as part of the attribute update.

ObjectAttributeKey
Type: AttributeKey structure

The key of the attribute being updated.

ObjectIdentifierAndLinkNameTuple

Description

A pair of ObjectIdentifier and LinkName.

Members
LinkName
Type: string

The name of the link between the parent and the child object.

ObjectIdentifier
Type: string

The ID that is associated with the object.

ObjectNotDetachedException

Description

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

Members
Message
Type: string

ObjectReference

Description

The reference that identifies an object.

Members
Selector
Type: string

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

  • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

PathToObjectIdentifiers

Description

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

Members
ObjectIdentifiers
Type: Array of strings

Lists ObjectIdentifiers starting from directory root to the object in the request.

Path
Type: string

The path that is used to identify the object starting from directory root.

PolicyAttachment

Description

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

Members
ObjectIdentifier
Type: string

The ObjectIdentifier that is associated with PolicyAttachment.

PolicyId
Type: string

The ID of PolicyAttachment.

PolicyType
Type: string

The type of policy that can be associated with PolicyAttachment.

PolicyToPath

Description

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.

Members
Path
Type: string

The path that is referenced from the root.

Policies
Type: Array of PolicyAttachment structures

List of policy objects.

ResourceNotFoundException

Description

The specified resource could not be found.

Members
Message
Type: string

RetryableConflictException

Description

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.

Members
Message
Type: string

Rule

Description

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

Members
Parameters
Type: Associative array of custom strings keys (RuleParameterKey) to strings

The minimum and maximum parameters that are associated with the rule.

Type
Type: string

The type of attribute validation rule.

SchemaAlreadyExistsException

Description

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

Members
Message
Type: string

SchemaAlreadyPublishedException

Description

Indicates that a schema is already published.

Members
Message
Type: string

SchemaFacet

Description

A facet.

Members
FacetName
Type: string

The name of the facet. If this value is set, SchemaArn must also be set.

SchemaArn
Type: string

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

StillContainsLinksException

Description

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

Members
Message
Type: string

Tag

Description

The tag structure that contains a tag key and value.

Members
Key
Type: string

The key that is associated with the tag.

Value
Type: string

The value that is associated with the tag.

TypedAttributeValue

Description

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.

Members
BinaryValue
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A binary data value.

BooleanValue
Type: boolean

A Boolean data value.

DatetimeValue
Type: timestamp (string|DateTime or anything parsable by strtotime)

A date and time value.

NumberValue
Type: string

A number data value.

StringValue
Type: string

A string data value.

TypedAttributeValueRange

Description

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

Members
EndMode
Required: Yes
Type: string

The inclusive or exclusive range end.

EndValue
Type: TypedAttributeValue structure

The attribute value to terminate the range at.

StartMode
Required: Yes
Type: string

The inclusive or exclusive range start.

StartValue
Type: TypedAttributeValue structure

The value to start the range at.

TypedLinkAttributeDefinition

Description

A typed link attribute definition.

Members
DefaultValue
Type: TypedAttributeValue structure

The default value of the attribute (if configured).

IsImmutable
Type: boolean

Whether the attribute is mutable or not.

Name
Required: Yes
Type: string

The unique name of the typed link attribute.

RequiredBehavior
Required: Yes
Type: string

The required behavior of the TypedLinkAttributeDefinition.

Rules
Type: Associative array of custom strings keys (RuleKey) to Rule structures

Validation rules that are attached to the attribute definition.

Type
Required: Yes
Type: string

The type of the attribute.

TypedLinkAttributeRange

Description

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

Members
AttributeName
Type: string

The unique name of the typed link attribute.

Range
Required: Yes
Type: TypedAttributeValueRange structure

The range of attribute values that are being selected.

TypedLinkFacet

Description

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

Members
Attributes
Required: Yes
Type: Array of TypedLinkAttributeDefinition structures

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

IdentityAttributeOrder
Required: Yes
Type: Array of strings

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

Name
Required: Yes
Type: string

The unique name of the typed link facet.

TypedLinkFacetAttributeUpdate

Description

A typed link facet attribute update.

Members
Action
Required: Yes
Type: string

The action to perform when updating the attribute.

Attribute
Required: Yes
Type: TypedLinkAttributeDefinition structure

The attribute to update.

TypedLinkSchemaAndFacetName

Description

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

Members
SchemaArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

TypedLinkName
Required: Yes
Type: string

The unique name of the typed link facet.

TypedLinkSpecifier

Description

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.

Members
IdentityAttributeValues
Required: Yes
Type: Array of AttributeNameAndValue structures

Identifies the attribute value to update.

SourceObjectReference
Required: Yes
Type: ObjectReference structure

Identifies the source object that the typed link will attach to.

TargetObjectReference
Required: Yes
Type: ObjectReference structure

Identifies the target object that the typed link will attach to.

TypedLinkFacet
Required: Yes
Type: TypedLinkSchemaAndFacetName structure

Identifies the typed link facet that is associated with the typed link.

UnsupportedIndexTypeException

Description

Indicates that the requested index type is not supported.

Members
Message
Type: string

ValidationException

Description

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

Members
Message
Type: string