CloudDirectory / Client / detach_object

detach_object#

CloudDirectory.Client.detach_object(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.detach_object(
    DirectoryArn='string',
    ParentReference={
        'Selector': 'string'
    },
    LinkName='string'
)
Parameters:

  • DirectoryArn (string) –

    [REQUIRED]

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

  • ParentReference (dict) –

    [REQUIRED]

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

    • 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

  • LinkName (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DetachedObjectIdentifier': 'string'
}

Response Structure

  • (dict) –

    • DetachedObjectIdentifier (string) –

      The ObjectIdentifier that was detached from the object.

Exceptions