getIndex method

Future<GetIndexOutput> getIndex({ String? indexArn, String? indexName, String? vectorBucketName, })

Returns vector index attributes. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN).

Permissions

You must have the s3vectors:GetIndex permission to use this operation.

May throw NotFoundException. May throw ServiceUnavailableException.

Parameter indexArn : The ARN of the vector index.

Parameter indexName : The name of the vector index.

Parameter vectorBucketName : The name of the vector bucket that contains the vector index.

Implementation

Future<GetIndexOutput> getIndex({
  String? indexArn,
  String? indexName,
  String? vectorBucketName,
}) async {
  final $payload = <String, dynamic>{
    if (indexArn != null) 'indexArn': indexArn,
    if (indexName != null) 'indexName': indexName,
    if (vectorBucketName != null) 'vectorBucketName': vectorBucketName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/GetIndex',
    exceptionFnMap: _exceptionFns,
  );
  return GetIndexOutput.fromJson(response);
}