CloudDirectory / Client / attach_typed_link

attach_typed_link#

CloudDirectory.Client.attach_typed_link(**kwargs)#

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

Request Syntax

response = client.attach_typed_link(
    DirectoryArn='string',
    SourceObjectReference={
        'Selector': 'string'
    },
    TargetObjectReference={
        'Selector': 'string'
    },
    TypedLinkFacet={
        'SchemaArn': 'string',
        'TypedLinkName': 'string'
    },
    Attributes=[
        {
            'AttributeName': 'string',
            'Value': {
                'StringValue': 'string',
                'BinaryValue': b'bytes',
                'BooleanValue': True|False,
                'NumberValue': 'string',
                'DatetimeValue': datetime(2015, 1, 1)
            }
        },
    ]
)

Parameters:

DirectoryArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.
SourceObjectReference (dict) –
[REQUIRED]

Identifies the source object that the typed link will attach to.
- 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
TargetObjectReference (dict) –
[REQUIRED]

Identifies the target object that the typed link will attach to.
- 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
TypedLinkFacet (dict) –
[REQUIRED]

Identifies the typed link facet that is associated with the typed link.
- SchemaArn (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
- TypedLinkName (string) – [REQUIRED]
  
  The unique name of the typed link facet.
Attributes (list) –
[REQUIRED]

A set of attributes that are associated with the typed link.
- (dict) –
  
  Identifies the attribute name and value for a typed link.
  - AttributeName (string) – [REQUIRED]
    
    The attribute name of the typed link.
  - Value (dict) – [REQUIRED]
    
    The value for the typed link.
    - StringValue (string) –
      
      A string data value.
    - BinaryValue (bytes) –
      
      A binary data value.
    - BooleanValue (boolean) –
      
      A Boolean data value.
    - NumberValue (string) –
      
      A number data value.
    - DatetimeValue (datetime) –
      
      A date and time value.

Return type:

dict

Returns:

Response Syntax

{
    'TypedLinkSpecifier': {
        'TypedLinkFacet': {
            'SchemaArn': 'string',
            'TypedLinkName': 'string'
        },
        'SourceObjectReference': {
            'Selector': 'string'
        },
        'TargetObjectReference': {
            'Selector': 'string'
        },
        'IdentityAttributeValues': [
            {
                'AttributeName': 'string',
                'Value': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                }
            },
        ]
    }
}

Response Structure

(dict) –
- TypedLinkSpecifier (dict) –
  
  Returns a typed link specifier as output.
  - TypedLinkFacet (dict) –
    
    Identifies the typed link facet that is associated with the typed link.
    - SchemaArn (string) –
      
      The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
    - TypedLinkName (string) –
      
      The unique name of the typed link facet.
  - SourceObjectReference (dict) –
    
    Identifies the source object that the typed link will attach to.
    - 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
  - TargetObjectReference (dict) –
    
    Identifies the target object that the typed link will attach to.
    - 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
  - IdentityAttributeValues (list) –
    
    Identifies the attribute value to update.
    - (dict) –
      
      Identifies the attribute name and value for a typed link.
      - AttributeName (string) –
        
        The attribute name of the typed link.
      - Value (dict) –
        
        The value for the typed link.
        
        StringValue (string) –
        
        A string data value.
        
        BinaryValue (bytes) –
        
        A binary data value.
        
        BooleanValue (boolean) –
        
        A Boolean data value.
        
        NumberValue (string) –
        
        A number data value.
        
        DatetimeValue (datetime) –
        
        A date and time value.

attach_typed_link#

Request Syntax

Response Syntax

Response Structure

Exceptions