detach_from_index

CloudDirectory.Client.detach_from_index(**kwargs)

Detaches the specified object from the specified index.

See also: AWS API Documentation

Request Syntax

response = client.detach_from_index(
    DirectoryArn='string',
    IndexReference={
        'Selector': 'string'
    },
    TargetReference={
        'Selector': 'string'
    }
)

Parameters

• DirectoryArn (string) --

  [REQUIRED]

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

• IndexReference (dict) --

  [REQUIRED]

  A reference to the index object.

  • Selector (string) --

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

    • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
    • /some/path - Identifies the object based on path
    • #SomeBatchReference - Identifies the object in a batch call
• TargetReference (dict) --

  [REQUIRED]

  A reference to the object being detached from the index.

  • Selector (string) --

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

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

Return type

dict

Returns

Response Syntax

{
    'DetachedObjectIdentifier': 'string'
}

Response Structure

• (dict) --

  • DetachedObjectIdentifier (string) --

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

Exceptions

• CloudDirectory.Client.exceptions.InternalServiceException
• CloudDirectory.Client.exceptions.InvalidArnException
• CloudDirectory.Client.exceptions.RetryableConflictException
• CloudDirectory.Client.exceptions.ValidationException
• CloudDirectory.Client.exceptions.LimitExceededException
• CloudDirectory.Client.exceptions.AccessDeniedException
• CloudDirectory.Client.exceptions.DirectoryNotEnabledException
• CloudDirectory.Client.exceptions.ResourceNotFoundException
• CloudDirectory.Client.exceptions.ObjectAlreadyDetachedException
• CloudDirectory.Client.exceptions.NotIndexException