AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Provides aggregated metrics and capacity usage information for a multi-page vector search operation.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.SearchVectorsMetrics

Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C# 
public sealed class SearchVectorsMetrics

The SearchVectorsMetrics type exposes the following members

Properties

NameTypeDescription
Public Property ConsumedCapacityHistory System.Collections.Generic.IReadOnlyList<Amazon.DynamoDBv2.Model.VectorCapacity>

Gets the history of consumed capacity details for all operations performed during the search.

Public Property ItemsReturnedLast System.Int32

Number of items returned in the last operation.

Public Property LastConsumedCapacity Amazon.DynamoDBv2.Model.VectorCapacity

Gets the details of the capacity units consumed by the most recent operation.

Public Property TotalItemsReturned System.Int32

Total number of items returned across all operations.

Public Property TotalVectorSearchRequestBytes System.Nullable<System.Double>

Gets the total consumed vector search request bytes accumulated across all operations performed during the search.

Public Property TotalVectorWriteRequestBytes System.Nullable<System.Double>

Gets the total accumulated vector write request bytes for all operations performed during the search.

Remarks

This class exposes read-only properties that summarize capacity consumption, item counts, and scan statistics across all pages retrieved during a vector search. Instances are typically returned by operations that support capacity reporting, such as paginated database queries. All properties reflect the cumulative or most recent values as appropriate, and are updated as additional pages are processed. This type is not intended to be instantiated directly.

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