CloudDirectory / Client / attach_object

attach_object#

CloudDirectory.Client.attach_object(**kwargs)#

Attaches an existing object to another object. An object can be accessed in two ways:

  • Using the path

  • Using ObjectIdentifier

See also: AWS API Documentation

Request Syntax

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

  • DirectoryArn (string) –

    [REQUIRED]

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

  • ParentReference (dict) –

    [REQUIRED]

    The parent object reference.

    • 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

  • ChildReference (dict) –

    [REQUIRED]

    The child object reference to be attached to 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

  • LinkName (string) –

    [REQUIRED]

    The link name with which the child object is attached to the parent.

Return type:

dict

Returns:

Response Syntax

{
    'AttachedObjectIdentifier': 'string'
}

Response Structure

  • (dict) –

    • AttachedObjectIdentifier (string) –

      The attached ObjectIdentifier, which is the child ObjectIdentifier.

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

  • CloudDirectory.Client.exceptions.InvalidAttachmentException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.FacetValidationException