delete_object

delete_object(**kwargs)

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

See also: AWS API Documentation

Request Syntax

response = client.delete_object(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [REQUIRED]

    A reference that identifies the 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
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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