Container for the parameters to the ListIndex operation. Lists objects attached to the specified index.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudDirectory.AmazonCloudDirectoryRequest
Amazon.CloudDirectory.Model.ListIndexRequest
Namespace: Amazon.CloudDirectory.Model
Assembly: AWSSDK.CloudDirectory.dll
Version: 3.x.y.z
Syntax
public class ListIndexRequest : AmazonCloudDirectoryRequest IAmazonWebServiceRequest
The ListIndexRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListIndexRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ConsistencyLevel | Amazon.CloudDirectory.ConsistencyLevel |
Gets and sets the property ConsistencyLevel. The consistency level to execute the request at. |
|
|
DirectoryArn | System.String |
Gets and sets the property DirectoryArn. The ARN of the directory that the index exists in. |
|
|
IndexReference | Amazon.CloudDirectory.Model.ObjectReference |
Gets and sets the property IndexReference. The reference to the index to list. |
|
|
MaxResults | System.Nullable<System.Int32> |
Gets and sets the property 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 | System.String |
Gets and sets the property NextToken. The pagination token. |
|
|
RangesOnIndexedValues | System.Collections.Generic.List<Amazon.CloudDirectory.Model.ObjectAttributeRange> |
Gets and sets the property RangesOnIndexedValues. Specifies the ranges of indexed values that you want to query. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
Examples
To list an index
var client = new AmazonCloudDirectoryClient();
var response = client.ListIndex(new ListIndexRequest
{
DirectoryArn = "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY",
IndexReference = new ObjectReference { Selector = "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" }
});
List<IndexAttachment> indexAttachments = response.IndexAttachments;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer