CloudDirectory / Client / update_object_attributes

update_object_attributes#

CloudDirectory.Client.update_object_attributes(**kwargs)#

Updates a given object’s attributes.

See also: AWS API Documentation

Request Syntax

response = client.update_object_attributes(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    AttributeUpdates=[
        {
            'ObjectAttributeKey': {
                'SchemaArn': 'string',
                'FacetName': 'string',
                'Name': 'string'
            },
            'ObjectAttributeAction': {
                'ObjectAttributeActionType': 'CREATE_OR_UPDATE'|'DELETE',
                'ObjectAttributeUpdateValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                }
            }
        },
    ]
)
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.

    • 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

  • AttributeUpdates (list) –

    [REQUIRED]

    The attributes update structure.

    • (dict) –

      Structure that contains attribute update information.

      • ObjectAttributeKey (dict) –

        The key of the attribute being updated.

        • SchemaArn (string) – [REQUIRED]

          The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

        • FacetName (string) – [REQUIRED]

          The name of the facet that the attribute exists within.

        • Name (string) – [REQUIRED]

          The name of the attribute.

      • ObjectAttributeAction (dict) –

        The action to perform as part of the attribute update.

        • ObjectAttributeActionType (string) –

          A type that can be either Update or Delete.

        • ObjectAttributeUpdateValue (dict) –

          The value that you want to update to.

          • 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

{
    'ObjectIdentifier': 'string'
}

Response Structure

  • (dict) –

    • ObjectIdentifier (string) –

      The ObjectIdentifier of the updated object.

Exceptions