CloudDirectory

Table of Contents

Client

class CloudDirectory.Client

A low-level client representing Amazon CloudDirectory:

import boto3

client = boto3.client('clouddirectory')

These are the available methods:

add_facet_to_object(**kwargs)

Adds a new Facet to an object.

See also: AWS API Documentation

Request Syntax

response = client.add_facet_to_object(
    DirectoryArn='string',
    SchemaFacet={
        'SchemaArn': 'string',
        'FacetName': 'string'
    },
    ObjectAttributeList=[
        {
            'Key': {
                'SchemaArn': 'string',
                'FacetName': 'string',
                'Name': 'string'
            },
            'Value': {
                'StringValue': 'string',
                'BinaryValue': b'bytes',
                'BooleanValue': True|False,
                'NumberValue': 'string',
                'DatetimeValue': datetime(2015, 1, 1)
            }
        },
    ],
    ObjectReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • SchemaFacet (dict) --

    [REQUIRED]

    Identifiers for the facet that you are adding to the object.

    • SchemaArn (string) --

      The ARN of the schema that contains the facet.

    • FacetName (string) --

      The name of the facet.

  • ObjectAttributeList (list) --

    Attributes on the facet you are adding to the object.

    • (dict) --

      The combination of an attribute key and an attribute value.

      • Key (dict) -- [REQUIRED]

        The key of the attribute.

        • SchemaArn (string) -- [REQUIRED]

          The ARN of the schema that contains the facet and attribute.

        • FacetName (string) -- [REQUIRED]

          The name of the facet the attribute exists within.

        • Name (string) -- [REQUIRED]

          The name of the attribute.

      • Value (dict) -- [REQUIRED]

        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.

  • ObjectReference (dict) --

    [REQUIRED]

    A reference to the object you are adding the specified facet to.

    • 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
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

apply_schema(**kwargs)

Copies input published schema into Directory with same name and version as that of published schema .

See also: AWS API Documentation

Request Syntax

response = client.apply_schema(
    PublishedSchemaArn='string',
    DirectoryArn='string'
)
Parameters
  • PublishedSchemaArn (string) --

    [REQUIRED]

    Published schema ARN that needs to be copied. For more information, see arns .

  • DirectoryArn (string) --

    [REQUIRED]

    ARN associated with the Directory into which the schema is copied. For more information, see arns .

Return type

dict

Returns

Response Syntax

{
    'AppliedSchemaArn': 'string',
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) --

    • AppliedSchemaArn (string) --

      Applied schema ARN associated with the copied schema in the Directory . You can use this ARN to describe the schema information applied on this directory. For more information, see arns .

    • DirectoryArn (string) --

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

attach_object(**kwargs)

Attaches an existing object to another object. An object can be accessed in two ways:

  • Using the path
  • Using ObjectIdentifier

See also: AWS API Documentation

Request Syntax

response = client.attach_object(
    DirectoryArn='string',
    ParentReference={
        'Selector': 'string'
    },
    ChildReference={
        'Selector': 'string'
    },
    LinkName='string'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    ARN associated with the Directory where both objects reside. For more information, see arns .

  • ParentReference (dict) --

    [REQUIRED]

    Parent object reference.

    • 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
  • ChildReference (dict) --

    [REQUIRED]

    Child object reference to be attached to the object.

    • 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
  • LinkName (string) --

    [REQUIRED]

    Link name with which the child object is attached to the parent.

Return type

dict

Returns

Response Syntax

{
    'AttachedObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • AttachedObjectIdentifier (string) --

      Attached ObjectIdentifier , which is the child ObjectIdentifier .

attach_policy(**kwargs)

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

See also: AWS API Documentation

Request Syntax

response = client.attach_policy(
    DirectoryArn='string',
    PolicyReference={
        'Selector': 'string'
    },
    ObjectReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) -- ARN associated with the Directory where both objects reside. For more information, see arns .
  • PolicyReference (dict) --

    [REQUIRED]

    Reference associated with the policy object.

    • 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
  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object to which the policy will be attached.

    • 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
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

attach_to_index(**kwargs)

Attaches the specified object to the specified index.

See also: AWS API Documentation

Request Syntax

response = client.attach_to_index(
    DirectoryArn='string',
    IndexReference={
        'Selector': 'string'
    },
    TargetReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory where the object and index exist.

  • IndexReference (dict) --

    [REQUIRED]

    A reference to the index that you are attaching the object to.

    • 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
  • TargetReference (dict) --

    [REQUIRED]

    A reference to the object that you are attaching to the index.

    • 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
Return type

dict

Returns

Response Syntax

{
    'AttachedObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • AttachedObjectIdentifier (string) --

      The ObjectIdentifier of the object that was attached to the index.

batch_read(**kwargs)

Performs all the read operations in a batch.

See also: AWS API Documentation

Request Syntax

response = client.batch_read(
    DirectoryArn='string',
    Operations=[
        {
            'ListObjectAttributes': {
                'ObjectReference': {
                    'Selector': 'string'
                },
                'NextToken': 'string',
                'MaxResults': 123
            },
            'ListObjectChildren': {
                'ObjectReference': {
                    'Selector': 'string'
                },
                'NextToken': 'string',
                'MaxResults': 123
            }
        },
    ],
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • Operations (list) --

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

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

  • 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.
Return type

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.

batch_write(**kwargs)

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.

See also: AWS API Documentation

Request Syntax

response = client.batch_write(
    DirectoryArn='string',
    Operations=[
        {
            'CreateObject': {
                'SchemaFacet': [
                    {
                        'SchemaArn': 'string',
                        'FacetName': 'string'
                    },
                ],
                'ObjectAttributeList': [
                    {
                        'Key': {
                            'SchemaArn': 'string',
                            'FacetName': 'string',
                            'Name': 'string'
                        },
                        'Value': {
                            'StringValue': 'string',
                            'BinaryValue': b'bytes',
                            'BooleanValue': True|False,
                            'NumberValue': 'string',
                            'DatetimeValue': datetime(2015, 1, 1)
                        }
                    },
                ],
                'ParentReference': {
                    'Selector': 'string'
                },
                'LinkName': 'string',
                'BatchReferenceName': 'string'
            },
            'AttachObject': {
                'ParentReference': {
                    'Selector': 'string'
                },
                'ChildReference': {
                    'Selector': 'string'
                },
                'LinkName': 'string'
            },
            'DetachObject': {
                'ParentReference': {
                    'Selector': 'string'
                },
                'LinkName': 'string',
                'BatchReferenceName': 'string'
            },
            'UpdateObjectAttributes': {
                '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)
                            }
                        }
                    },
                ]
            },
            'DeleteObject': {
                'ObjectReference': {
                    'Selector': 'string'
                }
            },
            'AddFacetToObject': {
                'SchemaFacet': {
                    'SchemaArn': 'string',
                    'FacetName': 'string'
                },
                'ObjectAttributeList': [
                    {
                        'Key': {
                            'SchemaArn': 'string',
                            'FacetName': 'string',
                            'Name': 'string'
                        },
                        'Value': {
                            'StringValue': 'string',
                            'BinaryValue': b'bytes',
                            'BooleanValue': True|False,
                            'NumberValue': 'string',
                            'DatetimeValue': datetime(2015, 1, 1)
                        }
                    },
                ],
                'ObjectReference': {
                    'Selector': 'string'
                }
            },
            'RemoveFacetFromObject': {
                'SchemaFacet': {
                    'SchemaArn': 'string',
                    'FacetName': 'string'
                },
                'ObjectReference': {
                    'Selector': 'string'
                }
            }
        },
    ]
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • Operations (list) --

    [REQUIRED]

    List of operations that are part of the batch.

    • (dict) --

      Represents the output of a BatchWrite operation.

      • CreateObject (dict) --

        Creates an object.

        • SchemaFacet (list) -- [REQUIRED]

          List of FacetArns that will be associated with the object. For more information, see arns .

          • (dict) --

            A facet.

            • SchemaArn (string) --

              The ARN of the schema that contains the facet.

            • FacetName (string) --

              The name of the facet.

        • ObjectAttributeList (list) -- [REQUIRED]

          Attribute map, which contains an attribute ARN as the key and attribute value as the map value.

          • (dict) --

            The combination of an attribute key and an attribute value.

            • Key (dict) -- [REQUIRED]

              The key of the attribute.

              • SchemaArn (string) -- [REQUIRED]

                The ARN of the schema that contains the facet and attribute.

              • FacetName (string) -- [REQUIRED]

                The name of the facet the attribute exists within.

              • Name (string) -- [REQUIRED]

                The name of the attribute.

            • Value (dict) -- [REQUIRED]

              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.

        • ParentReference (dict) -- [REQUIRED]

          If specified, the parent reference to which this object will be attached.

          • 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
        • LinkName (string) -- [REQUIRED]

          The name of the link.

        • BatchReferenceName (string) -- [REQUIRED]

          The batch reference name. See Batches for more information.

      • AttachObject (dict) --

        Attaches an object to a Directory .

        • ParentReference (dict) -- [REQUIRED]

          Parent object reference.

          • 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
        • ChildReference (dict) -- [REQUIRED]

          Child object reference to be attached to the object.

          • 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
        • LinkName (string) -- [REQUIRED]

          The name of the link.

      • DetachObject (dict) --

        Detaches an object from a Directory .

        • ParentReference (dict) -- [REQUIRED]

          Parent reference from which the object with the specified link name is detached.

          • 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
        • LinkName (string) -- [REQUIRED]

          The name of the link.

        • BatchReferenceName (string) -- [REQUIRED]

          The batch reference name. See Batches for more information.

      • UpdateObjectAttributes (dict) --

        Update a given object's attributes.

        • ObjectReference (dict) -- [REQUIRED]

          Reference that identifies the object.

          • 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
        • AttributeUpdates (list) -- [REQUIRED]

          Attributes update structure.

          • (dict) --

            Structure that contains attribute update information.

            • ObjectAttributeKey (dict) --

              The key of the attribute being updated.

              • SchemaArn (string) -- [REQUIRED]

                The ARN of the schema that contains the facet and attribute.

              • FacetName (string) -- [REQUIRED]

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

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

      • DeleteObject (dict) --

        Deletes an object in a Directory .

        • ObjectReference (dict) -- [REQUIRED]

          Reference that identifies the object.

          • 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
      • AddFacetToObject (dict) --

        Batch operation adding a facet to an object.

        • SchemaFacet (dict) -- [REQUIRED]

          Represents the facet being added to the object.

          • SchemaArn (string) --

            The ARN of the schema that contains the facet.

          • FacetName (string) --

            The name of the facet.

        • ObjectAttributeList (list) -- [REQUIRED]

          The attributes to set on the object.

          • (dict) --

            The combination of an attribute key and an attribute value.

            • Key (dict) -- [REQUIRED]

              The key of the attribute.

              • SchemaArn (string) -- [REQUIRED]

                The ARN of the schema that contains the facet and attribute.

              • FacetName (string) -- [REQUIRED]

                The name of the facet the attribute exists within.

              • Name (string) -- [REQUIRED]

                The name of the attribute.

            • Value (dict) -- [REQUIRED]

              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.

        • ObjectReference (dict) -- [REQUIRED]

          A reference to the object being mutated.

          • 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
      • RemoveFacetFromObject (dict) --

        Batch operation removing a facet from an object.

        • SchemaFacet (dict) -- [REQUIRED]

          The facet to remove from the object.

          • SchemaArn (string) --

            The ARN of the schema that contains the facet.

          • FacetName (string) --

            The name of the facet.

        • ObjectReference (dict) -- [REQUIRED]

          A reference to the object whose facet will be removed.

          • 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
Return type

dict

Returns

Response Syntax

{
    'Responses': [
        {
            'CreateObject': {
                'ObjectIdentifier': 'string'
            },
            'AttachObject': {
                'attachedObjectIdentifier': 'string'
            },
            'DetachObject': {
                'detachedObjectIdentifier': 'string'
            },
            'UpdateObjectAttributes': {
                'ObjectIdentifier': 'string'
            },
            'DeleteObject': {}
            ,
            'AddFacetToObject': {}
            ,
            'RemoveFacetFromObject': {}

        },
    ]
}

Response Structure

  • (dict) --

    • Responses (list) --

      List of all the responses for each batch write.

      • (dict) --

        Represents the output of a BatchWrite response operation.

        • CreateObject (dict) --

          Creates an object in a Directory .

          • ObjectIdentifier (string) --

            ID associated with the object.

        • AttachObject (dict) --

          Attaches an object to a Directory .

          • attachedObjectIdentifier (string) --

            The ObjectIdentifier of the object that has been attached.

        • DetachObject (dict) --

          Detaches an object from a Directory .

          • detachedObjectIdentifier (string) --

            The ObjectIdentifier of the detached object.

        • UpdateObjectAttributes (dict) --

          Updates a given object’s attributes.

          • ObjectIdentifier (string) --

            ID associated with the object.

        • DeleteObject (dict) --

          Deletes an object in a Directory .

        • AddFacetToObject (dict) --

          Result of an add facet to object batch operation.

        • RemoveFacetFromObject (dict) --

          Result of a batch remove facet from object operation.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_directory(**kwargs)

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

See also: AWS API Documentation

Request Syntax

response = client.create_directory(
    Name='string',
    SchemaArn='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the Directory . Should be unique per account, per region.

  • SchemaArn (string) --

    [REQUIRED]

    ARN of the published schema that will be copied into the data Directory . For more information, see arns .

Return type

dict

Returns

Response Syntax

{
    'DirectoryArn': 'string',
    'Name': 'string',
    'ObjectIdentifier': 'string',
    'AppliedSchemaArn': 'string'
}

Response Structure

  • (dict) --

    • DirectoryArn (string) --

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

    • Name (string) --

      Name of the Directory .

    • ObjectIdentifier (string) --

      The root object node of the created directory.

    • AppliedSchemaArn (string) --

      ARN of the published schema in the Directory . Once a published schema is copied into the directory, it has its own ARN which is referred to applied schema ARN. For more information, see arns .

create_facet(**kwargs)

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

See also: AWS API Documentation

Request Syntax

response = client.create_facet(
    SchemaArn='string',
    Name='string',
    Attributes=[
        {
            'Name': 'string',
            'AttributeDefinition': {
                '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'
                        }
                    }
                }
            },
            'AttributeReference': {
                'TargetFacetName': 'string',
                'TargetAttributeName': 'string'
            },
            'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
        },
    ],
    ObjectType='NODE'|'LEAF_NODE'|'POLICY'|'INDEX'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    Schema ARN in which the new Facet will be created. For more information, see arns .

  • Name (string) --

    [REQUIRED]

    Name of the Facet , which is unique for a given schema.

  • Attributes (list) --

    Attributes associated with the Facet .e

    • (dict) --

      Attribute associated with the Facet .

      • Name (string) -- [REQUIRED]

        The name of the facet attribute.

      • AttributeDefinition (dict) --

        A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

        • 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 attached to the attribute definition.

          • (string) --
            • (dict) --

              Contains an ARN and parameters associated with the rule.

              • Type (string) --

                The type of attribute validation rule.

              • Parameters (dict) --

                Min and max parameters associated with the rule.

                • (string) --
                  • (string) --
      • AttributeReference (dict) --

        Attribute reference associated with the attribute. See Attribute References for more information.

        • TargetFacetName (string) -- [REQUIRED]

          Target facet name associated with the facet reference. See Attribute References for more information.

        • TargetAttributeName (string) -- [REQUIRED]

          Target attribute name associated with the facet reference. See Attribute References for more information.

      • RequiredBehavior (string) --

        The required behavior of the FacetAttribute .

  • ObjectType (string) --

    [REQUIRED]

    Specifies whether a given object created from this facet is of type Node, Leaf Node, Policy or Index.

    • Node: Can have multiple children but one parent.
    • Leaf Node: Cannot have children but can have multiple parents.
    • Policy: Allows you to store a policy document and policy type. For more information, see Policies .
    • Index: Can be created with the Index API.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_index(**kwargs)

Creates an index object. See Indexing for more information.

See also: AWS API Documentation

Request Syntax

response = client.create_index(
    DirectoryArn='string',
    OrderedIndexedAttributeList=[
        {
            'SchemaArn': 'string',
            'FacetName': 'string',
            'Name': 'string'
        },
    ],
    IsUnique=True|False,
    ParentReference={
        'Selector': 'string'
    },
    LinkName='string'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory where the index should be created.

  • OrderedIndexedAttributeList (list) --

    [REQUIRED]

    Specifies the Attributes that should be indexed on. Currently only a single attribute is supported.

    • (dict) --

      A unique identifier for an attribute.

      • SchemaArn (string) -- [REQUIRED]

        The ARN of the schema that contains the facet and attribute.

      • FacetName (string) -- [REQUIRED]

        The name of the facet the attribute exists within.

      • Name (string) -- [REQUIRED]

        The name of the attribute.

  • IsUnique (boolean) --

    [REQUIRED]

    Indicates whether objects with the same indexed attribute value can be added to the index.

  • ParentReference (dict) --

    A reference to the parent object that contains the index object.

    • 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
  • LinkName (string) -- The name of the link between the parent object and the index object.
Return type

dict

Returns

Response Syntax

{
    'ObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • ObjectIdentifier (string) --

      The ObjectIdentifier of the index created by this operation.

create_object(**kwargs)

Creates an object in a Directory . Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

See also: AWS API Documentation

Request Syntax

response = client.create_object(
    DirectoryArn='string',
    SchemaFacets=[
        {
            'SchemaArn': 'string',
            'FacetName': 'string'
        },
    ],
    ObjectAttributeList=[
        {
            'Key': {
                'SchemaArn': 'string',
                'FacetName': 'string',
                'Name': 'string'
            },
            'Value': {
                'StringValue': 'string',
                'BinaryValue': b'bytes',
                'BooleanValue': True|False,
                'NumberValue': 'string',
                'DatetimeValue': datetime(2015, 1, 1)
            }
        },
    ],
    ParentReference={
        'Selector': 'string'
    },
    LinkName='string'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    ARN associated with the Directory in which the object will be created. For more information, see arns .

  • SchemaFacets (list) --

    [REQUIRED]

    List of facet ARNs to be associated with the object. For more information, see arns .

    • (dict) --

      A facet.

      • SchemaArn (string) --

        The ARN of the schema that contains the facet.

      • FacetName (string) --

        The name of the facet.

  • ObjectAttributeList (list) --

    Attribute map whose attribute ARN contains the key and attribute value as the map value.

    • (dict) --

      The combination of an attribute key and an attribute value.

      • Key (dict) -- [REQUIRED]

        The key of the attribute.

        • SchemaArn (string) -- [REQUIRED]

          The ARN of the schema that contains the facet and attribute.

        • FacetName (string) -- [REQUIRED]

          The name of the facet the attribute exists within.

        • Name (string) -- [REQUIRED]

          The name of the attribute.

      • Value (dict) -- [REQUIRED]

        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.

  • ParentReference (dict) --

    If specified, the parent reference to which this object will be attached.

    • 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
  • LinkName (string) -- The name of link that is used to attach this object to a parent.
Return type

dict

Returns

Response Syntax

{
    'ObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • ObjectIdentifier (string) --

      Identifier associated with the object.

create_schema(**kwargs)

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
  • Published: Published schemas are immutable and have a version associated with them.
  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

See also: AWS API Documentation

Request Syntax

response = client.create_schema(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Name associated with the schema. This is unique to each account and in each region.

Return type
dict
Returns
Response Syntax
{
    'SchemaArn': 'string'
}

Response Structure

  • (dict) --
    • SchemaArn (string) --

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

delete_directory(**kwargs)

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

See also: AWS API Documentation

Request Syntax

response = client.delete_directory(
    DirectoryArn='string'
)
Parameters
DirectoryArn (string) --

[REQUIRED]

The ARN of the directory to delete.

Return type
dict
Returns
Response Syntax
{
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) --
    • DirectoryArn (string) --

      The ARN of the deleted directory.

delete_facet(**kwargs)

Deletes a given Facet . All attributes and Rule s associated with the facet will be deleted. Only development schema facets are allowed deletion.

See also: AWS API Documentation

Request Syntax

response = client.delete_facet(
    SchemaArn='string',
    Name='string'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

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

  • Name (string) --

    [REQUIRED]

    The name of the facet to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_object(**kwargs)

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

See also: AWS API Documentation

Request Syntax

response = client.delete_object(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object.

    • 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
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_schema(**kwargs)

Deletes a given schema. Schemas in a development and published state can only be deleted.

See also: AWS API Documentation

Request Syntax

response = client.delete_schema(
    SchemaArn='string'
)
Parameters
SchemaArn (string) --

[REQUIRED]

ARN of the development schema. For more information, see arns .

Return type
dict
Returns
Response Syntax
{
    'SchemaArn': 'string'
}

Response Structure

  • (dict) --
    • SchemaArn (string) --

      Input ARN that is returned as part of the response. For more information, see arns .

detach_from_index(**kwargs)

Detaches the specified object from the specified index.

See also: AWS API Documentation

Request Syntax

response = client.detach_from_index(
    DirectoryArn='string',
    IndexReference={
        'Selector': 'string'
    },
    TargetReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory the index and object exist in.

  • IndexReference (dict) --

    [REQUIRED]

    A reference to the index object.

    • 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
  • TargetReference (dict) --

    [REQUIRED]

    A reference to the object being detached from the index.

    • 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
Return type

dict

Returns

Response Syntax

{
    'DetachedObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • DetachedObjectIdentifier (string) --

      The ObjectIdentifier of the object that was detached from the index.

detach_object(**kwargs)

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

See also: AWS API Documentation

Request Syntax

response = client.detach_object(
    DirectoryArn='string',
    ParentReference={
        'Selector': 'string'
    },
    LinkName='string'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ParentReference (dict) --

    [REQUIRED]

    Parent reference from which the object with the specified link name is detached.

    • 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
  • LinkName (string) --

    [REQUIRED]

    Link name associated with the object that needs to be detached.

Return type

dict

Returns

Response Syntax

{
    'DetachedObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • DetachedObjectIdentifier (string) --

      The ObjectIdentifier that was detached from the object.

detach_policy(**kwargs)

Detaches a policy from an object.

See also: AWS API Documentation

Request Syntax

response = client.detach_policy(
    DirectoryArn='string',
    PolicyReference={
        'Selector': 'string'
    },
    ObjectReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    ARN associated with the Directory where both objects reside. For more information, see arns .

  • PolicyReference (dict) --

    [REQUIRED]

    Reference that identifies the policy object.

    • 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
  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object whose policy object will be detached.

    • 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
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

disable_directory(**kwargs)

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

See also: AWS API Documentation

Request Syntax

response = client.disable_directory(
    DirectoryArn='string'
)
Parameters
DirectoryArn (string) --

[REQUIRED]

The ARN of the directory to disable.

Return type
dict
Returns
Response Syntax
{
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) --
    • DirectoryArn (string) --

      The ARN of the directory that has been disabled.

enable_directory(**kwargs)

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

See also: AWS API Documentation

Request Syntax

response = client.enable_directory(
    DirectoryArn='string'
)
Parameters
DirectoryArn (string) --

[REQUIRED]

The ARN of the directory to enable.

Return type
dict
Returns
Response Syntax
{
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) --
    • DirectoryArn (string) --

      The ARN of the enabled directory.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_directory(**kwargs)

Retrieves metadata about a directory.

See also: AWS API Documentation

Request Syntax

response = client.get_directory(
    DirectoryArn='string'
)
Parameters
DirectoryArn (string) --

[REQUIRED]

The ARN of the directory.

Return type
dict
Returns
Response Syntax
{
    'Directory': {
        'Name': 'string',
        'DirectoryArn': 'string',
        'State': 'ENABLED'|'DISABLED'|'DELETED',
        'CreationDateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • Directory (dict) --

      Metadata about the directory.

      • Name (string) --

        The name of the directory.

      • DirectoryArn (string) --

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

      • State (string) --

        The state of the directory. Can be either Enabled , Disabled , or Deleted .

      • CreationDateTime (datetime) --

        The date and time when the directory was created.

get_facet(**kwargs)

Gets details of the Facet , such as Facet Name, Attributes, Rule s, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

See also: AWS API Documentation

Request Syntax

response = client.get_facet(
    SchemaArn='string',
    Name='string'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

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

  • Name (string) --

    [REQUIRED]

    The name of the facet to retrieve.

Return type

dict

Returns

Response Syntax

{
    'Facet': {
        'Name': 'string',
        'ObjectType': 'NODE'|'LEAF_NODE'|'POLICY'|'INDEX'
    }
}

Response Structure

  • (dict) --

    • Facet (dict) --

      Facet structure associated with the facet.

      • Name (string) --

        The name of the Facet .

      • ObjectType (string) --

        Object type associated with the facet. See CreateFacetRequest$ObjectType for more details.

get_object_information(**kwargs)

Retrieves metadata about an object.

See also: AWS API Documentation

Request Syntax

response = client.get_object_information(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory being retrieved.

  • ObjectReference (dict) --

    [REQUIRED]

    A reference to the object.

    • 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
  • ConsistencyLevel (string) -- The consistency level at which to retrieve the object information.
Return type

dict

Returns

Response Syntax

{
    'SchemaFacets': [
        {
            'SchemaArn': 'string',
            'FacetName': 'string'
        },
    ],
    'ObjectIdentifier': 'string'
}

Response Structure

  • (dict) --

    • SchemaFacets (list) --

      The facets attached to the specified object.

      • (dict) --

        A facet.

        • SchemaArn (string) --

          The ARN of the schema that contains the facet.

        • FacetName (string) --

          The name of the facet.

    • ObjectIdentifier (string) --

      The ObjectIdentifier of the specified object.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_schema_as_json(**kwargs)

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

See also: AWS API Documentation

Request Syntax

response = client.get_schema_as_json(
    SchemaArn='string'
)
Parameters
SchemaArn (string) --

[REQUIRED]

The ARN of the schema to retrieve.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string',
    'Document': 'string'
}

Response Structure

  • (dict) --
    • Name (string) --

      The name of the retrieved schema.

    • Document (string) --

      The JSON representation of the schema document.

get_waiter(waiter_name)
list_applied_schema_arns(**kwargs)

Lists schemas applied to a directory.

See also: AWS API Documentation

Request Syntax

response = client.list_applied_schema_arns(
    DirectoryArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory you are listing.

  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • SchemaArns (list) --

      The ARNs of schemas that are applied to the directory.

      • (string) --
    • NextToken (string) --

      The pagination token.

list_attached_indices(**kwargs)

Lists indices attached to an object.

See also: AWS API Documentation

Request Syntax

response = client.list_attached_indices(
    DirectoryArn='string',
    TargetReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory.

  • TargetReference (dict) --

    [REQUIRED]

    A reference to the object to that has indices attached.

    • 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) -- The maximum number of results to retrieve.
  • ConsistencyLevel (string) -- The consistency level to use for this operation.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • IndexAttachments (list) --

      The indices attached to the specified object.

      • (dict) --

        Represents an index and an attached object.

        • IndexedAttributes (list) --

          The indexed attribute values.

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

        • ObjectIdentifier (string) --

          The ObjectIdentifier of the object attached to the index.

    • NextToken (string) --

      The pagination token.

list_development_schema_arns(**kwargs)

Retrieves the ARNs of schemas in the development state.

See also: AWS API Documentation

Request Syntax

response = client.list_development_schema_arns(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • SchemaArns (list) --

      The ARNs of retrieved development schemas.

      • (string) --
    • NextToken (string) --

      The pagination token.

list_directories(**kwargs)

Lists directories created within an account.

See also: AWS API Documentation

Request Syntax

response = client.list_directories(
    NextToken='string',
    MaxResults=123,
    state='ENABLED'|'DISABLED'|'DELETED'
)
Parameters
  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve.
  • state (string) -- The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.
Return type

dict

Returns

Response Syntax

{
    'Directories': [
        {
            'Name': 'string',
            'DirectoryArn': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'CreationDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Directories (list) --

      Lists all directories associated with your account in pagination fashion.

      • (dict) --

        Directory structure that includes the directory name and directory ARN.

        • Name (string) --

          The name of the directory.

        • DirectoryArn (string) --

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

        • State (string) --

          The state of the directory. Can be either Enabled , Disabled , or Deleted .

        • CreationDateTime (datetime) --

          The date and time when the directory was created.

    • NextToken (string) --

      The pagination token.

list_facet_attributes(**kwargs)

Retrieves attributes attached to the facet.

See also: AWS API Documentation

Request Syntax

response = client.list_facet_attributes(
    SchemaArn='string',
    Name='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    The ARN of the schema where the facet resides.

  • Name (string) --

    [REQUIRED]

    The name of the facet whose attributes will be retrieved.

  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Attributes': [
        {
            'Name': 'string',
            'AttributeDefinition': {
                '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'
                        }
                    }
                }
            },
            'AttributeReference': {
                'TargetFacetName': 'string',
                'TargetAttributeName': 'string'
            },
            'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Attributes (list) --

      The attributes attached to the facet.

      • (dict) --

        Attribute associated with the Facet .

        • Name (string) --

          The name of the facet attribute.

        • AttributeDefinition (dict) --

          A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

          • 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 attached to the attribute definition.

            • (string) --

              • (dict) --

                Contains an ARN and parameters associated with the rule.

                • Type (string) --

                  The type of attribute validation rule.

                • Parameters (dict) --

                  Min and max parameters associated with the rule.

                  • (string) --
                    • (string) --
        • AttributeReference (dict) --

          Attribute reference associated with the attribute. See Attribute References for more information.

          • TargetFacetName (string) --

            Target facet name associated with the facet reference. See Attribute References for more information.

          • TargetAttributeName (string) --

            Target attribute name associated with the facet reference. See Attribute References for more information.

        • RequiredBehavior (string) --

          The required behavior of the FacetAttribute .

    • NextToken (string) --

      The pagination token.

list_facet_names(**kwargs)

Retrieves the names of facets that exist in a schema.

See also: AWS API Documentation

Request Syntax

response = client.list_facet_names(
    SchemaArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    The ARN to retrieve facet names from.

  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • FacetNames (list) --

      The names of facets that exist within the schema.

      • (string) --
    • NextToken (string) --

      The pagination token.

list_index(**kwargs)

Lists objects attached to the specified index.

See also: AWS API Documentation

Request Syntax

response = client.list_index(
    DirectoryArn='string',
    RangesOnIndexedValues=[
        {
            'AttributeKey': {
                'SchemaArn': 'string',
                'FacetName': 'string',
                'Name': '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)
                }
            }
        },
    ],
    IndexReference={
        'Selector': 'string'
    },
    MaxResults=123,
    NextToken='string',
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory that the index exists in.

  • RangesOnIndexedValues (list) --

    Specifies the ranges of indexed values that you want to query.

    • (dict) --

      A range of attributes.

      • AttributeKey (dict) --

        The key of the attribute the attribute range covers.

        • SchemaArn (string) -- [REQUIRED]

          The ARN of the schema that contains the facet and attribute.

        • FacetName (string) -- [REQUIRED]

          The name of the facet the attribute exists within.

        • Name (string) -- [REQUIRED]

          The name of the attribute.

      • Range (dict) --

        The range of attribute values being selected.

        • StartMode (string) -- [REQUIRED]

          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]

          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.

  • IndexReference (dict) --

    [REQUIRED]

    The reference to the index to list.

    • 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
  • MaxResults (integer) -- The maximum number of results to retrieve from the index.
  • NextToken (string) -- The pagination token.
  • ConsistencyLevel (string) -- The consistency level to execute the request at.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • IndexAttachments (list) --

      The objects and indexed values attached to the index.

      • (dict) --

        Represents an index and an attached object.

        • IndexedAttributes (list) --

          The indexed attribute values.

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

        • ObjectIdentifier (string) --

          The ObjectIdentifier of the object attached to the index.

    • NextToken (string) --

      The pagination token.

list_object_attributes(**kwargs)

Lists all attributes associated with an object.

See also: AWS API Documentation

Request Syntax

response = client.list_object_attributes(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [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
  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- 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.
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 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.

list_object_children(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_object_children(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies 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.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Children': {
        'string': 'string'
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) --

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

list_object_parent_paths(**kwargs)

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure .

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults , in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to directory root are ignored from the target object.

See also: AWS API Documentation

Request Syntax

response = client.list_object_parent_paths(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory to which the parent path applies.

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object whose parent paths are 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.
Return type

dict

Returns

Response Syntax

{
    'PathToObjectIdentifiersList': [
        {
            'Path': 'string',
            'ObjectIdentifiers': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PathToObjectIdentifiersList (list) --

      Returns the path to the ObjectIdentifiers associated with the directory.

      • (dict) --

        Returns the path to the ObjectIdentifiers associated with the directory.

        • Path (string) --

          The path used to identify the object starting from directory root.

        • ObjectIdentifiers (list) --

          Lists ObjectIdentifiers starting from directory root to the object in the request.

          • (string) --
    • NextToken (string) --

      The pagination token.

list_object_parents(**kwargs)

Lists parent objects associated with a given object in pagination fashion.

See also: AWS API Documentation

Request Syntax

response = client.list_object_parents(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object for which parent 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.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Parents': {
        'string': 'string'
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Parents (dict) --

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

      • (string) --
        • (string) --
    • NextToken (string) --

      The pagination token.

list_object_policies(**kwargs)

Returns policies attached to an object in pagination fashion.

See also: AWS API Documentation

Request Syntax

response = client.list_object_policies(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object for which policies 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
  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- 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.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • AttachedPolicyIds (list) --

      List of policy ObjectIdentifiers , that are attached to the object.

      • (string) --
    • NextToken (string) --

      The pagination token.

list_policy_attachments(**kwargs)

Returns all of the ObjectIdentifiers to which a given policy is attached.

See also: AWS API Documentation

Request Syntax

response = client.list_policy_attachments(
    DirectoryArn='string',
    PolicyReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • PolicyReference (dict) --

    [REQUIRED]

    Reference that identifies the policy object.

    • 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.
  • 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.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • ObjectIdentifiers (list) --

      List of ObjectIdentifiers to which the policy is attached.

      • (string) --
    • NextToken (string) --

      The pagination token.

list_published_schema_arns(**kwargs)

Retrieves published schema ARNs.

See also: AWS API Documentation

Request Syntax

response = client.list_published_schema_arns(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • SchemaArns (list) --

      The ARNs of published schemas.

      • (string) --
    • NextToken (string) --

      The pagination token.

list_tags_for_resource(**kwargs)

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    ARN of the resource. Tagging is only supported for directories.

  • NextToken (string) -- The pagination token. This is for future use. Currently pagination is not supported for tagging.
  • MaxResults (integer) -- The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.
Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Tags (list) --

      List of tag key value pairs associated with the response.

      • (dict) --

        Tag structure which contains tag key and value.

        • Key (string) --

          Key associated with the tag.

        • Value (string) --

          Value associated with the tag.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

lookup_policy(**kwargs)

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier , policyId , and policyType . Paths that don't lead to the root from the target object are ignored.

See also: AWS API Documentation

Request Syntax

response = client.lookup_policy(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

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

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object whose policies will be looked up.

    • 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 token to request the next page of results.
  • MaxResults (integer) -- Maximum number of items to be retrieved in a single call. This is an approximate number.
Return type

dict

Returns

Response Syntax

{
    'PolicyToPathList': [
        {
            'Path': 'string',
            'Policies': [
                {
                    'PolicyId': 'string',
                    'ObjectIdentifier': 'string',
                    'PolicyType': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PolicyToPathList (list) --

      Provides list of path to policies. Policies contain PolicyId , ObjectIdentifier , and PolicyType .

      • (dict) --

        Used when a regular object exists in a Directory and you want to find all of the policies associated with that object and the parent to that object.

        • Path (string) --

          The path that is referenced from the root.

        • Policies (list) --

          List of policy objects.

          • (dict) --

            Contains the PolicyType , PolicyId , and the ObjectIdentifier to which it is attached.

            • PolicyId (string) --

              The ID of PolicyAttachment .

            • ObjectIdentifier (string) --

              The ObjectIdentifier associated with PolicyAttachment .

            • PolicyType (string) --

              The type of policy that can be associated with PolicyAttachment .

    • NextToken (string) --

      The pagination token.

publish_schema(**kwargs)

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

See also: AWS API Documentation

Request Syntax

response = client.publish_schema(
    DevelopmentSchemaArn='string',
    Version='string',
    Name='string'
)
Parameters
  • DevelopmentSchemaArn (string) --

    [REQUIRED]

    ARN associated with the development schema. For more information, see arns .

  • Version (string) --

    [REQUIRED]

    Version under which the schema will be published.

  • Name (string) -- New name under which the schema will be published. If this is not provided, the development schema is considered.
Return type

dict

Returns

Response Syntax

{
    'PublishedSchemaArn': 'string'
}

Response Structure

  • (dict) --

    • PublishedSchemaArn (string) --

      ARN associated with the published schema. For more information, see arns .

put_schema_from_json(**kwargs)

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

See also: AWS API Documentation

Request Syntax

response = client.put_schema_from_json(
    SchemaArn='string',
    Document='string'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    The ARN of the schema to update.

  • Document (string) --

    [REQUIRED]

    The replacement JSON schema.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN of the schema to update.

remove_facet_from_object(**kwargs)

Removes the specified facet from the specified object.

See also: AWS API Documentation

Request Syntax

response = client.remove_facet_from_object(
    DirectoryArn='string',
    SchemaFacet={
        'SchemaArn': 'string',
        'FacetName': 'string'
    },
    ObjectReference={
        'Selector': 'string'
    }
)
Parameters
  • DirectoryArn (string) --

    [REQUIRED]

    The ARN of the directory in which the object resides.

  • SchemaFacet (dict) --

    [REQUIRED]

    The facet to remove.

    • SchemaArn (string) --

      The ARN of the schema that contains the facet.

    • FacetName (string) --

      The name of the facet.

  • ObjectReference (dict) --

    [REQUIRED]

    A reference to the object to remove the facet from.

    • 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
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

tag_resource(**kwargs)

API for adding tags to a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    ARN of the resource. Tagging is only supported for directories.

  • Tags (list) --

    [REQUIRED]

    List of tag key value pairs.

    • (dict) --

      Tag structure which contains tag key and value.

      • Key (string) --

        Key associated with the tag.

      • Value (string) --

        Value associated with the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

API for removing tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    ARN of the resource. Tagging is only supported for directories.

  • TagKeys (list) --

    [REQUIRED]

    Keys of the tag that needs to be removed from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_facet(**kwargs)

Does the following:

  • Adds new Attributes , Rules , or ObjectTypes .
  • Updates existing Attributes , Rules , or ObjectTypes .
  • Deletes existing Attributes , Rules , or ObjectTypes .

See also: AWS API Documentation

Request Syntax

response = client.update_facet(
    SchemaArn='string',
    Name='string',
    AttributeUpdates=[
        {
            'Attribute': {
                'Name': 'string',
                'AttributeDefinition': {
                    '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'
                            }
                        }
                    }
                },
                'AttributeReference': {
                    'TargetFacetName': 'string',
                    'TargetAttributeName': 'string'
                },
                'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
            },
            'Action': 'CREATE_OR_UPDATE'|'DELETE'
        },
    ],
    ObjectType='NODE'|'LEAF_NODE'|'POLICY'|'INDEX'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

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

  • Name (string) -- [REQUIRED]
  • AttributeUpdates (list) --

    List of attributes that need to be updated in a given schema Facet . Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

    • (dict) --

      A structure that contains information used to update an attribute.

      • Attribute (dict) --

        The attribute to update.

        • Name (string) -- [REQUIRED]

          The name of the facet attribute.

        • AttributeDefinition (dict) --

          A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

          • 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 attached to the attribute definition.

            • (string) --
              • (dict) --

                Contains an ARN and parameters associated with the rule.

                • Type (string) --

                  The type of attribute validation rule.

                • Parameters (dict) --

                  Min and max parameters associated with the rule.

                  • (string) --
                    • (string) --
        • AttributeReference (dict) --

          Attribute reference associated with the attribute. See Attribute References for more information.

          • TargetFacetName (string) -- [REQUIRED]

            Target facet name associated with the facet reference. See Attribute References for more information.

          • TargetAttributeName (string) -- [REQUIRED]

            Target attribute name associated with the facet reference. See Attribute References for more information.

        • RequiredBehavior (string) --

          The required behavior of the FacetAttribute .

      • Action (string) --

        The action to perform when updating the attribute.

  • ObjectType (string) -- Object type associated with the facet. See CreateFacetRequest$ObjectType for more details.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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]

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

  • ObjectReference (dict) --

    [REQUIRED]

    Reference that identifies the object.

    • 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
  • AttributeUpdates (list) --

    [REQUIRED]

    Attributes update structure.

    • (dict) --

      Structure that contains attribute update information.

      • ObjectAttributeKey (dict) --

        The key of the attribute being updated.

        • SchemaArn (string) -- [REQUIRED]

          The ARN of the schema that contains the facet and attribute.

        • FacetName (string) -- [REQUIRED]

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

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

      ObjectIdentifier of the updated object.

update_schema(**kwargs)

Updates the schema name with a new name. Only development schema names can be updated.

See also: AWS API Documentation

Request Syntax

response = client.update_schema(
    SchemaArn='string',
    Name='string'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    ARN of the development schema. For more information, see arns .

  • Name (string) --

    [REQUIRED]

    Name of the schema.

Return type

dict

Returns

Response Syntax

{
    'SchemaArn': 'string'
}

Response Structure

  • (dict) --

    • SchemaArn (string) --

      ARN associated with the updated schema. For more information, see arns .

Paginators

The available paginators are: