CloudDirectory / Client / list_object_attributes

list_object_attributes#

CloudDirectory.Client.list_object_attributes(**kwargs)#

Lists all attributes that are associated with an object.

Request Syntax

response = client.list_object_attributes(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL',
    FacetFilter={
        'SchemaArn': 'string',
        'FacetName': '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]

The 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
NextToken (string) – The pagination token.
MaxResults (integer) – The maximum number of items to be retrieved in a single call. This is an approximate number.
ConsistencyLevel (string) – Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
FacetFilter (dict) –
Used to filter the list of object attributes that are associated with a certain facet.
- SchemaArn (string) –
  
  The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.
- FacetName (string) –
  
  The name of the facet. If this value is set, SchemaArn must also be set.

Return type:

dict

Returns:

Response Syntax

{
    'Attributes': [
        {
            'Key': {
                'SchemaArn': 'string',
                'FacetName': 'string',
                'Name': 'string'
            },
            'Value': {
                'StringValue': 'string',
                'BinaryValue': b'bytes',
                'BooleanValue': True|False,
                'NumberValue': 'string',
                'DatetimeValue': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Attributes (list) –
  
  Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.
  - (dict) –
    
    The combination of an attribute key and an attribute value.
    - Key (dict) –
      
      The key of the attribute.
      - SchemaArn (string) –
        
        The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.
      - FacetName (string) –
        
        The name of the facet that the attribute exists within.
      - Name (string) –
        
        The name of the attribute.
    - Value (dict) –
      
      The value of the attribute.
      - 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.

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.InvalidNextTokenException
CloudDirectory.Client.exceptions.FacetValidationException