Amazon CloudDirectory

2017/03/31 - Amazon CloudDirectory - 2 updated api methods

Changes  ListObjectAttributes now supports filtering by facet.

BatchRead (updated) Link ¶
Changes (request)
{'Operations': {'ListObjectAttributes': {'FacetFilter': {'FacetName': 'string',
                                                         'SchemaArn': 'string'}}}}

Performs all the read operations in a batch.

See also: AWS API Documentation

Request Syntax

client.batch_read(
    DirectoryArn='string',
    Operations=[
        {
            'ListObjectAttributes': {
                'ObjectReference': {
                    'Selector': 'string'
                },
                'NextToken': 'string',
                'MaxResults': 123,
                'FacetFilter': {
                    'SchemaArn': 'string',
                    'FacetName': 'string'
                }
            },
            'ListObjectChildren': {
                'ObjectReference': {
                    'Selector': 'string'
                },
                'NextToken': 'string',
                'MaxResults': 123
            }
        },
    ],
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
type DirectoryArn

string

param DirectoryArn

[REQUIRED]

ARN associated with the Directory . For more information, see arns .

type Operations

list

param Operations

[REQUIRED]

List of operations that are part of the batch.

  • (dict) --

    Represents the output of a BatchRead operation.

    • ListObjectAttributes (dict) --

      Lists all attributes associated with an object.

      • ObjectReference (dict) -- [REQUIRED]

        Reference of the object whose attributes need to be listed.

        • Selector (string) --

          Allows you to specify an object. You can identify an object in one of the following ways:

          • $ObjectIdentifier - Identifies the object by ObjectIdentifier

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken (string) --

        The pagination token.

      • MaxResults (integer) --

        Maximum number of items to be retrieved in a single call. This is an approximate number.

      • FacetFilter (dict) --

        Used to filter the list of object attributes associated with a certain facet.

        • SchemaArn (string) --

          The ARN of the schema that contains the facet.

        • FacetName (string) --

          The name of the facet.

    • ListObjectChildren (dict) --

      Returns a paginated list of child objects that are associated with a given object.

      • ObjectReference (dict) -- [REQUIRED]

        Reference of the object for which child objects are being listed.

        • Selector (string) --

          Allows you to specify an object. You can identify an object in one of the following ways:

          • $ObjectIdentifier - Identifies the object by ObjectIdentifier

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken (string) --

        The pagination token.

      • MaxResults (integer) --

        Maximum number of items to be retrieved in a single call. This is an approximate number.

type ConsistencyLevel

string

param ConsistencyLevel

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.

rtype

dict

returns

Response Syntax

{
    'Responses': [
        {
            'SuccessfulResponse': {
                'ListObjectAttributes': {
                    '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'
                },
                'ListObjectChildren': {
                    'Children': {
                        'string': 'string'
                    },
                    'NextToken': 'string'
                }
            },
            'ExceptionResponse': {
                'Type': 'ValidationException'|'InvalidArnException'|'ResourceNotFoundException'|'InvalidNextTokenException'|'AccessDeniedException'|'NotNodeException',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Responses (list) --

      List of all the responses for each batch read.

      • (dict) --

        Represents the output of a BatchRead response operation.

        • SuccessfulResponse (dict) --

          Identifies which operation in a batch has succeeded.

          • ListObjectAttributes (dict) --

            Lists all attributes associated with an object.

            • Attributes (list) --

              Attributes map associated with the object. AttributeArn is the key; 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 ARN of the schema that contains the facet and attribute.

                  • FacetName (string) --

                    The name of the facet 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.

          • ListObjectChildren (dict) --

            Returns a paginated list of child objects associated with a given object.

            • Children (dict) --

              Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

              • (string) --

                • (string) --

            • NextToken (string) --

              The pagination token.

        • ExceptionResponse (dict) --

          Identifies which operation in a batch has failed.

          • Type (string) --

            Type of exception, such as InvalidArnException .

          • Message (string) --

            Exception message associated with the failure.

ListObjectAttributes (updated) Link ¶
Changes (request)
{'FacetFilter': {'FacetName': 'string', 'SchemaArn': 'string'}}

Lists all attributes associated with an object.

See also: AWS API Documentation

Request Syntax

client.list_object_attributes(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL',
    FacetFilter={
        'SchemaArn': 'string',
        'FacetName': 'string'
    }
)
type DirectoryArn

string

param DirectoryArn

[REQUIRED]

ARN associated with the Directory where the object resides. For more information, see arns .

type ObjectReference

dict

param ObjectReference

[REQUIRED]

Reference that identifies the object whose attributes will be listed.

  • Selector (string) --

    Allows you to specify an object. You can identify an object in one of the following ways:

    • $ObjectIdentifier - Identifies the object by ObjectIdentifier

    • /some/path - Identifies the object based on path

    • #SomeBatchReference - Identifies the object in a batch call

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

Maximum number of items to be retrieved in a single call. This is an approximate number.

type ConsistencyLevel

string

param ConsistencyLevel

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.

type FacetFilter

dict

param FacetFilter

Used to filter the list of object attributes associated with a certain facet.

  • SchemaArn (string) --

    The ARN of the schema that contains the facet.

  • FacetName (string) --

    The name of the facet.

rtype

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 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 ARN of the schema that contains the facet and attribute.

          • FacetName (string) --

            The name of the facet 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.