CloudDirectory / Client / list_incoming_typed_links

list_incoming_typed_links#

CloudDirectory.Client.list_incoming_typed_links(**kwargs)#

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Request Syntax

response = client.list_incoming_typed_links(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    FilterAttributeRanges=[
        {
            'AttributeName': 'string',
            'Range': {
                'StartMode': 'FIRST'|'LAST'|'LAST_BEFORE_MISSING_VALUES'|'INCLUSIVE'|'EXCLUSIVE',
                'StartValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                },
                'EndMode': 'FIRST'|'LAST'|'LAST_BEFORE_MISSING_VALUES'|'INCLUSIVE'|'EXCLUSIVE',
                'EndValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                }
            }
        },
    ],
    FilterTypedLink={
        'SchemaArn': 'string',
        'TypedLinkName': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)

Parameters:

DirectoryArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
ObjectReference (dict) –
[REQUIRED]

Reference that identifies the object whose attributes will be listed.
- 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
FilterAttributeRanges (list) –
Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
- (dict) –
  
  Identifies the range of attributes that are used by a specified filter.
  - AttributeName (string) –
    
    The unique name of the typed link attribute.
  - Range (dict) – [REQUIRED]
    
    The range of attribute values that are being selected.
    - StartMode (string) – [REQUIRED]
      
      The inclusive or exclusive range start.
    - StartValue (dict) –
      
      The value to start the range at.
      - 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.
    - EndMode (string) – [REQUIRED]
      
      The inclusive or exclusive range end.
    - EndValue (dict) –
      
      The attribute value to terminate the range at.
      - 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.
FilterTypedLink (dict) –
Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.
- 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.
NextToken (string) – The pagination token.
MaxResults (integer) – The maximum number of results to retrieve.
ConsistencyLevel (string) – The consistency level to execute the request at.

Return type:

dict

Returns:

Response Syntax

{
    'LinkSpecifiers': [
        {
            '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)
                    }
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- LinkSpecifiers (list) –
  
  Returns one or more typed link specifiers as output.
  - (dict) –
    
    Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.
    - 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.
- NextToken (string) –
  
  The pagination token.

list_incoming_typed_links#

Request Syntax

Response Syntax

Response Structure

Exceptions