Amazon CloudDirectory 2017-01-11

AddFacetToObject

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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