List Index
clouddirectory_list_index | R Documentation |
Lists objects attached to the specified index¶
Description¶
Lists objects attached to the specified index.
Usage¶
clouddirectory_list_index(DirectoryArn, RangesOnIndexedValues,
IndexReference, MaxResults, NextToken, ConsistencyLevel)
Arguments¶
DirectoryArn
[required] The ARN of the directory that the index exists in.
RangesOnIndexedValues
Specifies the ranges of indexed values that you want to query.
IndexReference
[required] The reference to the index to list.
MaxResults
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
The pagination token.
ConsistencyLevel
The consistency level to execute the request at.
Value¶
A list with the following syntax:
list(
IndexAttachments = list(
list(
IndexedAttributes = list(
list(
Key = list(
SchemaArn = "string",
FacetName = "string",
Name = "string"
),
Value = list(
StringValue = "string",
BinaryValue = raw,
BooleanValue = TRUE|FALSE,
NumberValue = "string",
DatetimeValue = as.POSIXct(
"2015-01-01"
)
)
)
),
ObjectIdentifier = "string"
)
),
NextToken = "string"
)
Request syntax¶
svc$list_index(
DirectoryArn = "string",
RangesOnIndexedValues = list(
list(
AttributeKey = list(
SchemaArn = "string",
FacetName = "string",
Name = "string"
),
Range = list(
StartMode = "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
StartValue = list(
StringValue = "string",
BinaryValue = raw,
BooleanValue = TRUE|FALSE,
NumberValue = "string",
DatetimeValue = as.POSIXct(
"2015-01-01"
)
),
EndMode = "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
EndValue = list(
StringValue = "string",
BinaryValue = raw,
BooleanValue = TRUE|FALSE,
NumberValue = "string",
DatetimeValue = as.POSIXct(
"2015-01-01"
)
)
)
)
),
IndexReference = list(
Selector = "string"
),
MaxResults = 123,
NextToken = "string",
ConsistencyLevel = "SERIALIZABLE"|"EVENTUAL"
)