CloudDirectory / Client / list_attached_indices

list_attached_indices#

CloudDirectory.Client.list_attached_indices(**kwargs)#

Lists indices attached to the specified 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 that has indices attached.

    • Selector (string) –

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

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

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

      • #SomeBatchReference - Identifies the object in a batch call

  • NextToken (string) – The pagination token.

  • MaxResults (integer) – The maximum number of 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 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

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.InvalidArnException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.LimitExceededException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.DirectoryNotEnabledException

  • CloudDirectory.Client.exceptions.ResourceNotFoundException