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

Result Syntax

[]

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

FacetValidationException:

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

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

Result Syntax

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

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

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.

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

Result Syntax

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

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

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.

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

Result Syntax

[]

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

NotPolicyException:

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

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

Result Syntax

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

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

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.

AttachTypedLink

$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

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

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.

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

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

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.

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

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

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.

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

Result Syntax

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

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

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.

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

Result Syntax

[]

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

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.

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

Result Syntax

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

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

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.

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

Result Syntax

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

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

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.

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

Result Syntax

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

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

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.

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

Result Syntax

[]

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

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.

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

Result Syntax

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

Result Details

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.

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

Result Syntax

[]

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

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.

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

Result Syntax

[]

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

ObjectNotDetachedException:

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

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

Result Syntax

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

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

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.

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

Result Syntax

[]

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

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

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

Result Syntax

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

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

ObjectAlreadyDetachedException:

Indicates that the object is not attached to the index.

NotIndexException:

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

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

Result Syntax

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

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

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.

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

Result Syntax

[]

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

NotPolicyException:

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

DetachTypedLink

$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

Result Syntax

[]

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

FacetValidationException:

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

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

ResourceNotFoundException:

The specified resource could not be found.

FacetNotFoundException:

The specified Facet could not be found.

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

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

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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

ResourceNotFoundException:

The specified resource could not be found.

ValidationException:

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

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

Result Syntax

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

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

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.

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

Result Syntax

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

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

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

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

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

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.

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

Result Syntax

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

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

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

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

Result Syntax

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

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

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

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

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

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.

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

Result Syntax

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

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

ResourceNotFoundException:

The specified resource could not be found.

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ListIncomingTypedLinks

$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

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

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.

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

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

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.

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

Result Syntax

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

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

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

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

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.

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

Result Syntax

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

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

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.

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

Result Syntax

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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

InvalidNextTokenException:

Indicates that the NextToken value is not valid.

ListOutgoingTypedLinks

$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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

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

Result Syntax

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

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

ResourceNotFoundException:

The specified resource could not be found.

SchemaAlreadyPublishedException:

Indicates that a schema is already published.