CloudDirectory / Client / list_index

list_index#

CloudDirectory.Client.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 that the attribute range covers.

        • SchemaArn (string) – [REQUIRED]

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

        • FacetName (string) – [REQUIRED]

          The name of the facet that the attribute exists within.

        • Name (string) – [REQUIRED]

          The name of the attribute.

      • Range (dict) –

        The range of attribute values being selected.

        • StartMode (string) – [REQUIRED]

          The inclusive or exclusive range start.

        • StartValue (dict) –

          The value to start the range at.

          • StringValue (string) –

            A string data value.

          • BinaryValue (bytes) –

            A binary data value.

          • BooleanValue (boolean) –

            A Boolean data value.

          • NumberValue (string) –

            A number data value.

          • DatetimeValue (datetime) –

            A date and time value.

        • EndMode (string) – [REQUIRED]

          The inclusive or exclusive range end.

        • EndValue (dict) –

          The attribute value to terminate the range at.

          • StringValue (string) –

            A string data value.

          • BinaryValue (bytes) –

            A binary data value.

          • BooleanValue (boolean) –

            A Boolean data value.

          • NumberValue (string) –

            A number data value.

          • DatetimeValue (datetime) –

            A date and time value.

  • IndexReference (dict) –

    [REQUIRED]

    The reference to the index to list.

    • Selector (string) –

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

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

      • #SomeBatchReference - Identifies the object in a batch call

  • MaxResults (integer) – The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

  • 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 Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

              • FacetName (string) –

                The name of the facet that the attribute exists within.

              • Name (string) –

                The name of the attribute.

            • Value (dict) –

              The value of the attribute.

              • StringValue (string) –

                A string data value.

              • BinaryValue (bytes) –

                A binary data value.

              • BooleanValue (boolean) –

                A Boolean data value.

              • NumberValue (string) –

                A number data value.

              • DatetimeValue (datetime) –

                A date and time value.

        • ObjectIdentifier (string) –

          In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

    • NextToken (string) –

      The pagination token.

Exceptions