AWS API Changes

2017/05/30 - Amazon CloudDirectory - 10 new api methods

Changes Cloud Directory has launched support for Typed Links, enabling customers to create object-to-object relationships that are not hierarchical in nature. Typed Links enable customers to quickly query for data along these relationships. Customers can also enforce referential integrity using Typed Links, ensuring data in use is not inadvertently deleted.

DeleteTypedLinkFacet (new)

Link ¶

Deletes a TypedLinkFacet . For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.delete_typed_link_facet(
    SchemaArn='string',
    Name='string'
)

type SchemaArn

string

param SchemaArn

[REQUIRED]

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

type Name

string

param Name

[REQUIRED]

The unique name of the typed link facet.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DetachTypedLink (new)

Link ¶

Detaches a typed link from a specified source and target object. For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.detach_typed_link(
    DirectoryArn='string',
    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)
                }
            },
        ]
    }
)

type DirectoryArn

string

param DirectoryArn

[REQUIRED]

The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

type TypedLinkSpecifier

dict

param TypedLinkSpecifier

[REQUIRED]

Used to accept a typed link specifier as input.

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.
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 Accessing 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
  - /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 Accessing 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
  - /some/path - Identifies the object based on path
  - #SomeBatchReference - Identifies the object in a batch call
IdentityAttributeValues (list) -- [REQUIRED]

Identifies the attribute value to update.
- (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.

returns

None

CreateTypedLinkFacet (new)

Link ¶

Creates a TypedLinkFacet . For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.create_typed_link_facet(
    SchemaArn='string',
    Facet={
        'Name': 'string',
        'Attributes': [
            {
                'Name': 'string',
                'Type': 'STRING'|'BINARY'|'BOOLEAN'|'NUMBER'|'DATETIME',
                'DefaultValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                },
                'IsImmutable': True|False,
                'Rules': {
                    'string': {
                        'Type': 'BINARY_LENGTH'|'NUMBER_COMPARISON'|'STRING_FROM_SET'|'STRING_LENGTH',
                        'Parameters': {
                            'string': 'string'
                        }
                    }
                },
                'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
            },
        ],
        'IdentityAttributeOrder': [
            'string',
        ]
    }
)

type SchemaArn

string

param SchemaArn

[REQUIRED]

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

type Facet

dict

param Facet

[REQUIRED]

Facet structure that is associated with the typed link facet.

Name (string) -- [REQUIRED]

The unique name of the typed link facet.
Attributes (list) -- [REQUIRED]

An ordered set of attributes that are associate with the typed link. You can use typed link attributes when you need to represent the relationship between two objects or allow for quick filtering of incoming or outgoing typed links.
- (dict) --
  
  A typed link attribute definition.
  - Name (string) -- [REQUIRED]
    
    The unique name of the typed link attribute.
  - Type (string) -- [REQUIRED]
    
    The type of the attribute.
  - DefaultValue (dict) --
    
    The default value of the attribute (if configured).
    - 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.
  - IsImmutable (boolean) --
    
    Whether the attribute is mutable or not.
  - Rules (dict) --
    
    Validation rules that are attached to the attribute definition.
    - (string) --
      - (dict) --
        
        Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
        
        Type (string) --
        
        The type of attribute validation rule.
        
        Parameters (dict) --
        
        The minimum and maximum parameters that are associated with the rule.
        
        (string) --
        
        (string) --
  - RequiredBehavior (string) -- [REQUIRED]
    
    The required behavior of the TypedLinkAttributeDefinition .
IdentityAttributeOrder (list) -- [REQUIRED]

A range filter that you provide for multiple attributes. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. 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. 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.
- (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListOutgoingTypedLinks (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_outgoing_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'
)

type DirectoryArn

string

param DirectoryArn

[REQUIRED]

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

type ObjectReference

dict

param ObjectReference

[REQUIRED]

A 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 Accessing 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
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call

type FilterAttributeRanges

list

param FilterAttributeRanges

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.

type FilterTypedLink

dict

param FilterTypedLink

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order 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.

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum number of results to retrieve.

type ConsistencyLevel

string

param ConsistencyLevel

The consistency level to execute the request at.

rtype

dict

returns

Response Syntax

{
    'TypedLinkSpecifiers': [
        {
            '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) --
- TypedLinkSpecifiers (list) --
  
  Returns a typed link specifier 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 Accessing 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
        
        /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 Accessing 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
        
        /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.

ListTypedLinkFacetAttributes (new)

Link ¶

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet . For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.list_typed_link_facet_attributes(
    SchemaArn='string',
    Name='string',
    NextToken='string',
    MaxResults=123
)

type SchemaArn

string

param SchemaArn

[REQUIRED]

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

type Name

string

param Name

[REQUIRED]

The unique name of the typed link facet.

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum number of results to retrieve.

rtype

dict

returns

Response Syntax

{
    'Attributes': [
        {
            'Name': 'string',
            'Type': 'STRING'|'BINARY'|'BOOLEAN'|'NUMBER'|'DATETIME',
            'DefaultValue': {
                'StringValue': 'string',
                'BinaryValue': b'bytes',
                'BooleanValue': True|False,
                'NumberValue': 'string',
                'DatetimeValue': datetime(2015, 1, 1)
            },
            'IsImmutable': True|False,
            'Rules': {
                'string': {
                    'Type': 'BINARY_LENGTH'|'NUMBER_COMPARISON'|'STRING_FROM_SET'|'STRING_LENGTH',
                    'Parameters': {
                        'string': 'string'
                    }
                }
            },
            'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Attributes (list) --
  
  An ordered set of attributes associate with the typed link.
  - (dict) --
    
    A typed link attribute definition.
    - Name (string) --
      
      The unique name of the typed link attribute.
    - Type (string) --
      
      The type of the attribute.
    - DefaultValue (dict) --
      
      The default value of the attribute (if configured).
      - 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.
    - IsImmutable (boolean) --
      
      Whether the attribute is mutable or not.
    - Rules (dict) --
      
      Validation rules that are attached to the attribute definition.
      - (string) --
        
        (dict) --
        
        Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
        
        Type (string) --
        
        The type of attribute validation rule.
        
        Parameters (dict) --
        
        The minimum and maximum parameters that are associated with the rule.
        
        (string) --
        
        (string) --
    - RequiredBehavior (string) --
      
      The required behavior of the TypedLinkAttributeDefinition .
- NextToken (string) --
  
  The pagination token.

AttachTypedLink (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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)
            }
        },
    ]
)

type DirectoryArn

string

param DirectoryArn

[REQUIRED]

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

type SourceObjectReference

dict

param SourceObjectReference

[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 Accessing 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
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call

type TargetObjectReference

dict

param TargetObjectReference

[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 Accessing 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
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call

type TypedLinkFacet

dict

param TypedLinkFacet

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

type Attributes

list

param Attributes

[REQUIRED]

An ordered 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.

rtype

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 Accessing 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
      - /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 Accessing 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
      - /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.

ListIncomingTypedLinks (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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'
)

type DirectoryArn

string

param DirectoryArn

[REQUIRED]

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

type ObjectReference

dict

param ObjectReference

[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 Accessing 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
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call

type FilterAttributeRanges

list

param FilterAttributeRanges

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

type FilterTypedLink

dict

param FilterTypedLink

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.

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum number of results to retrieve.

type ConsistencyLevel

string

param ConsistencyLevel

The consistency level to execute the request at.

rtype

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 a typed link specifier 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 Accessing 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
        
        /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 Accessing 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
        
        /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.

ListTypedLinkFacetNames (new)

Link ¶

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.list_typed_link_facet_names(
    SchemaArn='string',
    NextToken='string',
    MaxResults=123
)

type SchemaArn

string

param SchemaArn

[REQUIRED]

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum number of results to retrieve.

rtype

dict

returns

Response Syntax

{
    'FacetNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- FacetNames (list) --
  
  The names of typed link facets that exist within the schema.
  - (string) --
- NextToken (string) --
  
  The pagination token.

GetTypedLinkFacetInformation (new)

Link ¶

Returns the identity attribute order for a specific TypedLinkFacet . For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.get_typed_link_facet_information(
    SchemaArn='string',
    Name='string'
)

type SchemaArn

string

param SchemaArn

[REQUIRED]

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

type Name

string

param Name

[REQUIRED]

The unique name of the typed link facet.

rtype

dict

returns

Response Syntax

{
    'IdentityAttributeOrder': [
        'string',
    ]
}

Response Structure

(dict) --
- IdentityAttributeOrder (list) --
  
  A range filter that you provide for multiple attributes. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. 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. 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.
  - (string) --

UpdateTypedLinkFacet (new)

Link ¶

Updates a TypedLinkFacet . For more information, see Typed link .

See also: AWS API Documentation

Request Syntax

client.update_typed_link_facet(
    SchemaArn='string',
    Name='string',
    AttributeUpdates=[
        {
            'Attribute': {
                'Name': 'string',
                'Type': 'STRING'|'BINARY'|'BOOLEAN'|'NUMBER'|'DATETIME',
                'DefaultValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                },
                'IsImmutable': True|False,
                'Rules': {
                    'string': {
                        'Type': 'BINARY_LENGTH'|'NUMBER_COMPARISON'|'STRING_FROM_SET'|'STRING_LENGTH',
                        'Parameters': {
                            'string': 'string'
                        }
                    }
                },
                'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
            },
            'Action': 'CREATE_OR_UPDATE'|'DELETE'
        },
    ],
    IdentityAttributeOrder=[
        'string',
    ]
)

type SchemaArn

string

param SchemaArn

[REQUIRED]

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .

type Name

string

param Name

[REQUIRED]

The unique name of the typed link facet.

type AttributeUpdates

list

param AttributeUpdates

[REQUIRED]

Attributes update structure.

(dict) --

A typed link facet attribute update.
- Attribute (dict) -- [REQUIRED]
  
  The attribute to update.
  - Name (string) -- [REQUIRED]
    
    The unique name of the typed link attribute.
  - Type (string) -- [REQUIRED]
    
    The type of the attribute.
  - DefaultValue (dict) --
    
    The default value of the attribute (if configured).
    - 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.
  - IsImmutable (boolean) --
    
    Whether the attribute is mutable or not.
  - Rules (dict) --
    
    Validation rules that are attached to the attribute definition.
    - (string) --
      - (dict) --
        
        Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.
        
        Type (string) --
        
        The type of attribute validation rule.
        
        Parameters (dict) --
        
        The minimum and maximum parameters that are associated with the rule.
        
        (string) --
        
        (string) --
  - RequiredBehavior (string) -- [REQUIRED]
    
    The required behavior of the TypedLinkAttributeDefinition .
- Action (string) -- [REQUIRED]
  
  The action to perform when updating the attribute.

type IdentityAttributeOrder

list

param IdentityAttributeOrder

[REQUIRED]

A range filter that you provide for multiple attributes. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a 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. 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.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --