aws-sdk-s3vectors 1.9.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3vectors/client.rb +259 -152
- data/lib/aws-sdk-s3vectors/client_api.rb +88 -2
- data/lib/aws-sdk-s3vectors/types.rb +167 -94
- data/lib/aws-sdk-s3vectors.rb +1 -1
- data/sig/client.rbs +38 -2
- data/sig/types.rbs +33 -2
- metadata +1 -1
|
@@ -66,6 +66,8 @@ module Aws::S3Vectors
|
|
|
66
66
|
ListIndexesOutputList = Shapes::ListShape.new(name: 'ListIndexesOutputList')
|
|
67
67
|
ListIndexesPrefix = Shapes::StringShape.new(name: 'ListIndexesPrefix')
|
|
68
68
|
ListOutputVector = Shapes::StructureShape.new(name: 'ListOutputVector')
|
|
69
|
+
ListTagsForResourceInput = Shapes::StructureShape.new(name: 'ListTagsForResourceInput')
|
|
70
|
+
ListTagsForResourceOutput = Shapes::StructureShape.new(name: 'ListTagsForResourceOutput')
|
|
69
71
|
ListVectorBucketsInput = Shapes::StructureShape.new(name: 'ListVectorBucketsInput')
|
|
70
72
|
ListVectorBucketsMaxResults = Shapes::IntegerShape.new(name: 'ListVectorBucketsMaxResults')
|
|
71
73
|
ListVectorBucketsNextToken = Shapes::StringShape.new(name: 'ListVectorBucketsNextToken')
|
|
@@ -94,13 +96,22 @@ module Aws::S3Vectors
|
|
|
94
96
|
QueryVectorsOutput = Shapes::StructureShape.new(name: 'QueryVectorsOutput')
|
|
95
97
|
QueryVectorsOutputList = Shapes::ListShape.new(name: 'QueryVectorsOutputList')
|
|
96
98
|
RequestTimeoutException = Shapes::StructureShape.new(name: 'RequestTimeoutException')
|
|
99
|
+
ResourceARN = Shapes::StringShape.new(name: 'ResourceARN')
|
|
97
100
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
|
98
101
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
|
99
102
|
SseType = Shapes::StringShape.new(name: 'SseType')
|
|
100
103
|
String = Shapes::StringShape.new(name: 'String')
|
|
104
|
+
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
|
105
|
+
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
|
106
|
+
TagResourceInput = Shapes::StructureShape.new(name: 'TagResourceInput')
|
|
107
|
+
TagResourceOutput = Shapes::StructureShape.new(name: 'TagResourceOutput')
|
|
108
|
+
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
|
109
|
+
TagsMap = Shapes::MapShape.new(name: 'TagsMap')
|
|
101
110
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
|
102
111
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
|
103
112
|
TopK = Shapes::IntegerShape.new(name: 'TopK')
|
|
113
|
+
UntagResourceInput = Shapes::StructureShape.new(name: 'UntagResourceInput')
|
|
114
|
+
UntagResourceOutput = Shapes::StructureShape.new(name: 'UntagResourceOutput')
|
|
104
115
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
|
105
116
|
ValidationExceptionField = Shapes::StructureShape.new(name: 'ValidationExceptionField')
|
|
106
117
|
ValidationExceptionFieldList = Shapes::ListShape.new(name: 'ValidationExceptionFieldList')
|
|
@@ -126,6 +137,8 @@ module Aws::S3Vectors
|
|
|
126
137
|
CreateIndexInput.add_member(:dimension, Shapes::ShapeRef.new(shape: Dimension, required: true, location_name: "dimension"))
|
|
127
138
|
CreateIndexInput.add_member(:distance_metric, Shapes::ShapeRef.new(shape: DistanceMetric, required: true, location_name: "distanceMetric"))
|
|
128
139
|
CreateIndexInput.add_member(:metadata_configuration, Shapes::ShapeRef.new(shape: MetadataConfiguration, location_name: "metadataConfiguration"))
|
|
140
|
+
CreateIndexInput.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: EncryptionConfiguration, location_name: "encryptionConfiguration"))
|
|
141
|
+
CreateIndexInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, location_name: "tags"))
|
|
129
142
|
CreateIndexInput.struct_class = Types::CreateIndexInput
|
|
130
143
|
|
|
131
144
|
CreateIndexOutput.add_member(:index_arn, Shapes::ShapeRef.new(shape: IndexArn, required: true, location_name: "indexArn"))
|
|
@@ -133,6 +146,7 @@ module Aws::S3Vectors
|
|
|
133
146
|
|
|
134
147
|
CreateVectorBucketInput.add_member(:vector_bucket_name, Shapes::ShapeRef.new(shape: VectorBucketName, required: true, location_name: "vectorBucketName"))
|
|
135
148
|
CreateVectorBucketInput.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: EncryptionConfiguration, location_name: "encryptionConfiguration"))
|
|
149
|
+
CreateVectorBucketInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, location_name: "tags"))
|
|
136
150
|
CreateVectorBucketInput.struct_class = Types::CreateVectorBucketInput
|
|
137
151
|
|
|
138
152
|
CreateVectorBucketOutput.add_member(:vector_bucket_arn, Shapes::ShapeRef.new(shape: VectorBucketArn, required: true, location_name: "vectorBucketArn"))
|
|
@@ -223,6 +237,7 @@ module Aws::S3Vectors
|
|
|
223
237
|
Index.add_member(:dimension, Shapes::ShapeRef.new(shape: Dimension, required: true, location_name: "dimension"))
|
|
224
238
|
Index.add_member(:distance_metric, Shapes::ShapeRef.new(shape: DistanceMetric, required: true, location_name: "distanceMetric"))
|
|
225
239
|
Index.add_member(:metadata_configuration, Shapes::ShapeRef.new(shape: MetadataConfiguration, location_name: "metadataConfiguration"))
|
|
240
|
+
Index.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: EncryptionConfiguration, location_name: "encryptionConfiguration"))
|
|
226
241
|
Index.struct_class = Types::Index
|
|
227
242
|
|
|
228
243
|
IndexSummary.add_member(:vector_bucket_name, Shapes::ShapeRef.new(shape: VectorBucketName, required: true, location_name: "vectorBucketName"))
|
|
@@ -264,6 +279,12 @@ module Aws::S3Vectors
|
|
|
264
279
|
ListOutputVector.add_member(:metadata, Shapes::ShapeRef.new(shape: VectorMetadata, location_name: "metadata"))
|
|
265
280
|
ListOutputVector.struct_class = Types::ListOutputVector
|
|
266
281
|
|
|
282
|
+
ListTagsForResourceInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceARN, required: true, location: "uri", location_name: "resourceArn"))
|
|
283
|
+
ListTagsForResourceInput.struct_class = Types::ListTagsForResourceInput
|
|
284
|
+
|
|
285
|
+
ListTagsForResourceOutput.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, required: true, location_name: "tags"))
|
|
286
|
+
ListTagsForResourceOutput.struct_class = Types::ListTagsForResourceOutput
|
|
287
|
+
|
|
267
288
|
ListVectorBucketsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: ListVectorBucketsMaxResults, location_name: "maxResults"))
|
|
268
289
|
ListVectorBucketsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: ListVectorBucketsNextToken, location_name: "nextToken"))
|
|
269
290
|
ListVectorBucketsInput.add_member(:prefix, Shapes::ShapeRef.new(shape: ListVectorBucketsPrefix, location_name: "prefix"))
|
|
@@ -322,10 +343,9 @@ module Aws::S3Vectors
|
|
|
322
343
|
|
|
323
344
|
PutVectorsOutput.struct_class = Types::PutVectorsOutput
|
|
324
345
|
|
|
346
|
+
QueryOutputVector.add_member(:distance, Shapes::ShapeRef.new(shape: Float, location_name: "distance"))
|
|
325
347
|
QueryOutputVector.add_member(:key, Shapes::ShapeRef.new(shape: VectorKey, required: true, location_name: "key"))
|
|
326
|
-
QueryOutputVector.add_member(:data, Shapes::ShapeRef.new(shape: VectorData, location_name: "data"))
|
|
327
348
|
QueryOutputVector.add_member(:metadata, Shapes::ShapeRef.new(shape: VectorMetadata, location_name: "metadata"))
|
|
328
|
-
QueryOutputVector.add_member(:distance, Shapes::ShapeRef.new(shape: Float, location_name: "distance"))
|
|
329
349
|
QueryOutputVector.struct_class = Types::QueryOutputVector
|
|
330
350
|
|
|
331
351
|
QueryVectorsInput.add_member(:vector_bucket_name, Shapes::ShapeRef.new(shape: VectorBucketName, location_name: "vectorBucketName"))
|
|
@@ -353,9 +373,26 @@ module Aws::S3Vectors
|
|
|
353
373
|
ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, required: true, location_name: "message"))
|
|
354
374
|
ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
|
|
355
375
|
|
|
376
|
+
TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
|
|
377
|
+
|
|
378
|
+
TagResourceInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceARN, required: true, location: "uri", location_name: "resourceArn"))
|
|
379
|
+
TagResourceInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, required: true, location_name: "tags"))
|
|
380
|
+
TagResourceInput.struct_class = Types::TagResourceInput
|
|
381
|
+
|
|
382
|
+
TagResourceOutput.struct_class = Types::TagResourceOutput
|
|
383
|
+
|
|
384
|
+
TagsMap.key = Shapes::ShapeRef.new(shape: TagKey)
|
|
385
|
+
TagsMap.value = Shapes::ShapeRef.new(shape: TagValue)
|
|
386
|
+
|
|
356
387
|
TooManyRequestsException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, required: true, location_name: "message"))
|
|
357
388
|
TooManyRequestsException.struct_class = Types::TooManyRequestsException
|
|
358
389
|
|
|
390
|
+
UntagResourceInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceARN, required: true, location: "uri", location_name: "resourceArn"))
|
|
391
|
+
UntagResourceInput.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location: "querystring", location_name: "tagKeys"))
|
|
392
|
+
UntagResourceInput.struct_class = Types::UntagResourceInput
|
|
393
|
+
|
|
394
|
+
UntagResourceOutput.struct_class = Types::UntagResourceOutput
|
|
395
|
+
|
|
359
396
|
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
|
360
397
|
ValidationException.add_member(:field_list, Shapes::ShapeRef.new(shape: ValidationExceptionFieldList, location_name: "fieldList"))
|
|
361
398
|
ValidationException.struct_class = Types::ValidationException
|
|
@@ -447,6 +484,7 @@ module Aws::S3Vectors
|
|
|
447
484
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
448
485
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
449
486
|
o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
|
|
487
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
450
488
|
end)
|
|
451
489
|
|
|
452
490
|
api.add_operation(:delete_vector_bucket, Seahorse::Model::Operation.new.tap do |o|
|
|
@@ -462,6 +500,7 @@ module Aws::S3Vectors
|
|
|
462
500
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
463
501
|
o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
|
|
464
502
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
503
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
465
504
|
end)
|
|
466
505
|
|
|
467
506
|
api.add_operation(:delete_vector_bucket_policy, Seahorse::Model::Operation.new.tap do |o|
|
|
@@ -583,6 +622,21 @@ module Aws::S3Vectors
|
|
|
583
622
|
)
|
|
584
623
|
end)
|
|
585
624
|
|
|
625
|
+
api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
|
|
626
|
+
o.name = "ListTagsForResource"
|
|
627
|
+
o.http_method = "GET"
|
|
628
|
+
o.http_request_uri = "/tags/{resourceArn}"
|
|
629
|
+
o.input = Shapes::ShapeRef.new(shape: ListTagsForResourceInput)
|
|
630
|
+
o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceOutput)
|
|
631
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
632
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
|
633
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
634
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
635
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
636
|
+
o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
|
|
637
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
638
|
+
end)
|
|
639
|
+
|
|
586
640
|
api.add_operation(:list_vector_buckets, Seahorse::Model::Operation.new.tap do |o|
|
|
587
641
|
o.name = "ListVectorBuckets"
|
|
588
642
|
o.http_method = "POST"
|
|
@@ -677,6 +731,38 @@ module Aws::S3Vectors
|
|
|
677
731
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
678
732
|
o.errors << Shapes::ShapeRef.new(shape: KmsDisabledException)
|
|
679
733
|
end)
|
|
734
|
+
|
|
735
|
+
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
|
736
|
+
o.name = "TagResource"
|
|
737
|
+
o.http_method = "POST"
|
|
738
|
+
o.http_request_uri = "/tags/{resourceArn}"
|
|
739
|
+
o.input = Shapes::ShapeRef.new(shape: TagResourceInput)
|
|
740
|
+
o.output = Shapes::ShapeRef.new(shape: TagResourceOutput)
|
|
741
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
742
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
|
743
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
744
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
745
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
746
|
+
o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
|
|
747
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
748
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
749
|
+
end)
|
|
750
|
+
|
|
751
|
+
api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o|
|
|
752
|
+
o.name = "UntagResource"
|
|
753
|
+
o.http_method = "DELETE"
|
|
754
|
+
o.http_request_uri = "/tags/{resourceArn}"
|
|
755
|
+
o.input = Shapes::ShapeRef.new(shape: UntagResourceInput)
|
|
756
|
+
o.output = Shapes::ShapeRef.new(shape: UntagResourceOutput)
|
|
757
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
758
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
|
759
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
760
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
761
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
762
|
+
o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
|
|
763
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
764
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
765
|
+
end)
|
|
680
766
|
end
|
|
681
767
|
|
|
682
768
|
end
|
|
@@ -69,6 +69,31 @@ module Aws::S3Vectors
|
|
|
69
69
|
# The metadata configuration for the vector index.
|
|
70
70
|
# @return [Types::MetadataConfiguration]
|
|
71
71
|
#
|
|
72
|
+
# @!attribute [rw] encryption_configuration
|
|
73
|
+
# The encryption configuration for a vector index. By default, if you
|
|
74
|
+
# don't specify, all new vectors in the vector index will use the
|
|
75
|
+
# encryption configuration of the vector bucket.
|
|
76
|
+
# @return [Types::EncryptionConfiguration]
|
|
77
|
+
#
|
|
78
|
+
# @!attribute [rw] tags
|
|
79
|
+
# An array of user-defined tags that you would like to apply to the
|
|
80
|
+
# vector index that you are creating. A tag is a key-value pair that
|
|
81
|
+
# you apply to your resources. Tags can help you organize, track
|
|
82
|
+
# costs, and control access to resources. For more information, see
|
|
83
|
+
# [Tagging for cost allocation or attribute-based access control
|
|
84
|
+
# (ABAC)][1].
|
|
85
|
+
#
|
|
86
|
+
# <note markdown="1"> You must have the `s3vectors:TagResource` permission in addition to
|
|
87
|
+
# `s3vectors:CreateIndex` permission to create a vector index with
|
|
88
|
+
# tags.
|
|
89
|
+
#
|
|
90
|
+
# </note>
|
|
91
|
+
#
|
|
92
|
+
#
|
|
93
|
+
#
|
|
94
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
|
|
95
|
+
# @return [Hash<String,String>]
|
|
96
|
+
#
|
|
72
97
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/CreateIndexInput AWS API Documentation
|
|
73
98
|
#
|
|
74
99
|
class CreateIndexInput < Struct.new(
|
|
@@ -78,7 +103,9 @@ module Aws::S3Vectors
|
|
|
78
103
|
:data_type,
|
|
79
104
|
:dimension,
|
|
80
105
|
:distance_metric,
|
|
81
|
-
:metadata_configuration
|
|
106
|
+
:metadata_configuration,
|
|
107
|
+
:encryption_configuration,
|
|
108
|
+
:tags)
|
|
82
109
|
SENSITIVE = []
|
|
83
110
|
include Aws::Structure
|
|
84
111
|
end
|
|
@@ -106,11 +133,30 @@ module Aws::S3Vectors
|
|
|
106
133
|
# specifically `AES256`.
|
|
107
134
|
# @return [Types::EncryptionConfiguration]
|
|
108
135
|
#
|
|
136
|
+
# @!attribute [rw] tags
|
|
137
|
+
# An array of user-defined tags that you would like to apply to the
|
|
138
|
+
# vector bucket that you are creating. A tag is a key-value pair that
|
|
139
|
+
# you apply to your resources. Tags can help you organize and control
|
|
140
|
+
# access to resources. For more information, see [Tagging for cost
|
|
141
|
+
# allocation or attribute-based access control (ABAC)][1].
|
|
142
|
+
#
|
|
143
|
+
# <note markdown="1"> You must have the `s3vectors:TagResource` permission in addition to
|
|
144
|
+
# `s3vectors:CreateVectorBucket` permission to create a vector bucket
|
|
145
|
+
# with tags.
|
|
146
|
+
#
|
|
147
|
+
# </note>
|
|
148
|
+
#
|
|
149
|
+
#
|
|
150
|
+
#
|
|
151
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
|
|
152
|
+
# @return [Hash<String,String>]
|
|
153
|
+
#
|
|
109
154
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/CreateVectorBucketInput AWS API Documentation
|
|
110
155
|
#
|
|
111
156
|
class CreateVectorBucketInput < Struct.new(
|
|
112
157
|
:vector_bucket_name,
|
|
113
|
-
:encryption_configuration
|
|
158
|
+
:encryption_configuration,
|
|
159
|
+
:tags)
|
|
114
160
|
SENSITIVE = []
|
|
115
161
|
include Aws::Structure
|
|
116
162
|
end
|
|
@@ -228,16 +274,12 @@ module Aws::S3Vectors
|
|
|
228
274
|
#
|
|
229
275
|
class DeleteVectorsOutput < Aws::EmptyStructure; end
|
|
230
276
|
|
|
231
|
-
#
|
|
232
|
-
# S3
|
|
233
|
-
# to change.
|
|
234
|
-
#
|
|
235
|
-
# </note>
|
|
236
|
-
#
|
|
237
|
-
# The encryption configuration for a vector bucket. By default, if you
|
|
238
|
-
# don't specify, all new vectors in Amazon S3 vector buckets use
|
|
277
|
+
# The encryption configuration for a vector bucket or index. By default,
|
|
278
|
+
# if you don't specify, all new vectors in Amazon S3 vector buckets use
|
|
239
279
|
# server-side encryption with Amazon S3 managed keys (SSE-S3),
|
|
240
|
-
# specifically `AES256`.
|
|
280
|
+
# specifically `AES256`. You can optionally override bucket level
|
|
281
|
+
# encryption settings, and set a specific encryption configuration for a
|
|
282
|
+
# vector index at the time of index creation.
|
|
241
283
|
#
|
|
242
284
|
# @!attribute [rw] sse_type
|
|
243
285
|
# The server-side encryption type to use for the encryption
|
|
@@ -302,13 +344,7 @@ module Aws::S3Vectors
|
|
|
302
344
|
include Aws::Structure
|
|
303
345
|
end
|
|
304
346
|
|
|
305
|
-
#
|
|
306
|
-
# S3 and is subject
|
|
307
|
-
# to change.
|
|
308
|
-
#
|
|
309
|
-
# </note>
|
|
310
|
-
#
|
|
311
|
-
# The attributes of a vector returned by the `GetVectors` operation.
|
|
347
|
+
# The attributes of a vector returned by the `GetVectors` operation.
|
|
312
348
|
#
|
|
313
349
|
# @!attribute [rw] key
|
|
314
350
|
# The name of the vector.
|
|
@@ -441,13 +477,7 @@ module Aws::S3Vectors
|
|
|
441
477
|
include Aws::Structure
|
|
442
478
|
end
|
|
443
479
|
|
|
444
|
-
#
|
|
445
|
-
# S3 and is subject
|
|
446
|
-
# to change.
|
|
447
|
-
#
|
|
448
|
-
# </note>
|
|
449
|
-
#
|
|
450
|
-
# The attributes of a vector index.
|
|
480
|
+
# The attributes of a vector index.
|
|
451
481
|
#
|
|
452
482
|
# @!attribute [rw] vector_bucket_name
|
|
453
483
|
# The name of the vector bucket that contains the vector index.
|
|
@@ -482,6 +512,12 @@ module Aws::S3Vectors
|
|
|
482
512
|
# The metadata configuration for the vector index.
|
|
483
513
|
# @return [Types::MetadataConfiguration]
|
|
484
514
|
#
|
|
515
|
+
# @!attribute [rw] encryption_configuration
|
|
516
|
+
# The encryption configuration for a vector index. By default, if you
|
|
517
|
+
# don't specify, all new vectors in the vector index will use the
|
|
518
|
+
# encryption configuration of the vector bucket.
|
|
519
|
+
# @return [Types::EncryptionConfiguration]
|
|
520
|
+
#
|
|
485
521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/Index AWS API Documentation
|
|
486
522
|
#
|
|
487
523
|
class Index < Struct.new(
|
|
@@ -492,18 +528,13 @@ module Aws::S3Vectors
|
|
|
492
528
|
:data_type,
|
|
493
529
|
:dimension,
|
|
494
530
|
:distance_metric,
|
|
495
|
-
:metadata_configuration
|
|
531
|
+
:metadata_configuration,
|
|
532
|
+
:encryption_configuration)
|
|
496
533
|
SENSITIVE = []
|
|
497
534
|
include Aws::Structure
|
|
498
535
|
end
|
|
499
536
|
|
|
500
|
-
#
|
|
501
|
-
# S3 and is subject
|
|
502
|
-
# to change.
|
|
503
|
-
#
|
|
504
|
-
# </note>
|
|
505
|
-
#
|
|
506
|
-
# Summary information about a vector index.
|
|
537
|
+
# Summary information about a vector index.
|
|
507
538
|
#
|
|
508
539
|
# @!attribute [rw] vector_bucket_name
|
|
509
540
|
# The name of the vector bucket that contains the vector index.
|
|
@@ -668,13 +699,7 @@ module Aws::S3Vectors
|
|
|
668
699
|
include Aws::Structure
|
|
669
700
|
end
|
|
670
701
|
|
|
671
|
-
#
|
|
672
|
-
# S3 and is subject
|
|
673
|
-
# to change.
|
|
674
|
-
#
|
|
675
|
-
# </note>
|
|
676
|
-
#
|
|
677
|
-
# The attributes of a vector returned by the `ListVectors` operation.
|
|
702
|
+
# The attributes of a vector returned by the `ListVectors` operation.
|
|
678
703
|
#
|
|
679
704
|
# @!attribute [rw] key
|
|
680
705
|
# The name of the vector.
|
|
@@ -698,6 +723,38 @@ module Aws::S3Vectors
|
|
|
698
723
|
include Aws::Structure
|
|
699
724
|
end
|
|
700
725
|
|
|
726
|
+
# @!attribute [rw] resource_arn
|
|
727
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource
|
|
728
|
+
# that you want to list tags for. The tagged resource can be a vector
|
|
729
|
+
# bucket or a vector index.
|
|
730
|
+
# @return [String]
|
|
731
|
+
#
|
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/ListTagsForResourceInput AWS API Documentation
|
|
733
|
+
#
|
|
734
|
+
class ListTagsForResourceInput < Struct.new(
|
|
735
|
+
:resource_arn)
|
|
736
|
+
SENSITIVE = []
|
|
737
|
+
include Aws::Structure
|
|
738
|
+
end
|
|
739
|
+
|
|
740
|
+
# @!attribute [rw] tags
|
|
741
|
+
# The user-defined tags that are applied to the S3 Vectors resource.
|
|
742
|
+
# For more information, see [Tagging for cost allocation or
|
|
743
|
+
# attribute-based access control (ABAC)][1].
|
|
744
|
+
#
|
|
745
|
+
#
|
|
746
|
+
#
|
|
747
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
|
|
748
|
+
# @return [Hash<String,String>]
|
|
749
|
+
#
|
|
750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/ListTagsForResourceOutput AWS API Documentation
|
|
751
|
+
#
|
|
752
|
+
class ListTagsForResourceOutput < Struct.new(
|
|
753
|
+
:tags)
|
|
754
|
+
SENSITIVE = []
|
|
755
|
+
include Aws::Structure
|
|
756
|
+
end
|
|
757
|
+
|
|
701
758
|
# @!attribute [rw] max_results
|
|
702
759
|
# The maximum number of vector buckets to be returned in the response.
|
|
703
760
|
# @return [Integer]
|
|
@@ -844,13 +901,7 @@ module Aws::S3Vectors
|
|
|
844
901
|
include Aws::Structure
|
|
845
902
|
end
|
|
846
903
|
|
|
847
|
-
#
|
|
848
|
-
# S3 and is subject
|
|
849
|
-
# to change.
|
|
850
|
-
#
|
|
851
|
-
# </note>
|
|
852
|
-
#
|
|
853
|
-
# The metadata configuration for a vector index.
|
|
904
|
+
# The metadata configuration for a vector index.
|
|
854
905
|
#
|
|
855
906
|
# @!attribute [rw] non_filterable_metadata_keys
|
|
856
907
|
# Non-filterable metadata keys allow you to enrich vectors with
|
|
@@ -890,13 +941,7 @@ module Aws::S3Vectors
|
|
|
890
941
|
include Aws::Structure
|
|
891
942
|
end
|
|
892
943
|
|
|
893
|
-
#
|
|
894
|
-
# S3 and is subject
|
|
895
|
-
# to change.
|
|
896
|
-
#
|
|
897
|
-
# </note>
|
|
898
|
-
#
|
|
899
|
-
# The attributes of a vector to add to a vector index.
|
|
944
|
+
# The attributes of a vector to add to a vector index.
|
|
900
945
|
#
|
|
901
946
|
# @!attribute [rw] key
|
|
902
947
|
# The name of the vector. The key uniquely identifies the vector in a
|
|
@@ -999,39 +1044,27 @@ module Aws::S3Vectors
|
|
|
999
1044
|
#
|
|
1000
1045
|
class PutVectorsOutput < Aws::EmptyStructure; end
|
|
1001
1046
|
|
|
1002
|
-
#
|
|
1003
|
-
# S3 and is subject
|
|
1004
|
-
# to change.
|
|
1005
|
-
#
|
|
1006
|
-
# </note>
|
|
1047
|
+
# The attributes of a vector in the approximate nearest neighbor search.
|
|
1007
1048
|
#
|
|
1008
|
-
#
|
|
1009
|
-
#
|
|
1049
|
+
# @!attribute [rw] distance
|
|
1050
|
+
# The measure of similarity between the vector in the response and the
|
|
1051
|
+
# query vector.
|
|
1052
|
+
# @return [Float]
|
|
1010
1053
|
#
|
|
1011
1054
|
# @!attribute [rw] key
|
|
1012
1055
|
# The key of the vector in the approximate nearest neighbor search.
|
|
1013
1056
|
# @return [String]
|
|
1014
1057
|
#
|
|
1015
|
-
# @!attribute [rw] data
|
|
1016
|
-
# The vector data associated with the vector, if requested.
|
|
1017
|
-
# @return [Types::VectorData]
|
|
1018
|
-
#
|
|
1019
1058
|
# @!attribute [rw] metadata
|
|
1020
1059
|
# The metadata associated with the vector, if requested.
|
|
1021
1060
|
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1022
1061
|
#
|
|
1023
|
-
# @!attribute [rw] distance
|
|
1024
|
-
# The measure of similarity between the vector in the response and the
|
|
1025
|
-
# query vector.
|
|
1026
|
-
# @return [Float]
|
|
1027
|
-
#
|
|
1028
1062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/QueryOutputVector AWS API Documentation
|
|
1029
1063
|
#
|
|
1030
1064
|
class QueryOutputVector < Struct.new(
|
|
1065
|
+
:distance,
|
|
1031
1066
|
:key,
|
|
1032
|
-
:
|
|
1033
|
-
:metadata,
|
|
1034
|
-
:distance)
|
|
1067
|
+
:metadata)
|
|
1035
1068
|
SENSITIVE = []
|
|
1036
1069
|
include Aws::Structure
|
|
1037
1070
|
end
|
|
@@ -1153,6 +1186,35 @@ module Aws::S3Vectors
|
|
|
1153
1186
|
include Aws::Structure
|
|
1154
1187
|
end
|
|
1155
1188
|
|
|
1189
|
+
# @!attribute [rw] resource_arn
|
|
1190
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource
|
|
1191
|
+
# that you're applying tags to. The tagged resource can be a vector
|
|
1192
|
+
# bucket or a vector index.
|
|
1193
|
+
# @return [String]
|
|
1194
|
+
#
|
|
1195
|
+
# @!attribute [rw] tags
|
|
1196
|
+
# The user-defined tag that you want to add to the specified S3
|
|
1197
|
+
# Vectors resource. For more information, see [Tagging for cost
|
|
1198
|
+
# allocation or attribute-based access control (ABAC)][1].
|
|
1199
|
+
#
|
|
1200
|
+
#
|
|
1201
|
+
#
|
|
1202
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
|
|
1203
|
+
# @return [Hash<String,String>]
|
|
1204
|
+
#
|
|
1205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/TagResourceInput AWS API Documentation
|
|
1206
|
+
#
|
|
1207
|
+
class TagResourceInput < Struct.new(
|
|
1208
|
+
:resource_arn,
|
|
1209
|
+
:tags)
|
|
1210
|
+
SENSITIVE = []
|
|
1211
|
+
include Aws::Structure
|
|
1212
|
+
end
|
|
1213
|
+
|
|
1214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/TagResourceOutput AWS API Documentation
|
|
1215
|
+
#
|
|
1216
|
+
class TagResourceOutput < Aws::EmptyStructure; end
|
|
1217
|
+
|
|
1156
1218
|
# The request was denied due to request throttling.
|
|
1157
1219
|
#
|
|
1158
1220
|
# @!attribute [rw] message
|
|
@@ -1166,6 +1228,35 @@ module Aws::S3Vectors
|
|
|
1166
1228
|
include Aws::Structure
|
|
1167
1229
|
end
|
|
1168
1230
|
|
|
1231
|
+
# @!attribute [rw] resource_arn
|
|
1232
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource
|
|
1233
|
+
# that you're removing tags from. The tagged resource can be a vector
|
|
1234
|
+
# bucket or a vector index.
|
|
1235
|
+
# @return [String]
|
|
1236
|
+
#
|
|
1237
|
+
# @!attribute [rw] tag_keys
|
|
1238
|
+
# The array of tag keys that you're removing from the S3 Vectors
|
|
1239
|
+
# resource. For more information, see [Tagging for cost allocation or
|
|
1240
|
+
# attribute-based access control (ABAC)][1].
|
|
1241
|
+
#
|
|
1242
|
+
#
|
|
1243
|
+
#
|
|
1244
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
|
|
1245
|
+
# @return [Array<String>]
|
|
1246
|
+
#
|
|
1247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/UntagResourceInput AWS API Documentation
|
|
1248
|
+
#
|
|
1249
|
+
class UntagResourceInput < Struct.new(
|
|
1250
|
+
:resource_arn,
|
|
1251
|
+
:tag_keys)
|
|
1252
|
+
SENSITIVE = []
|
|
1253
|
+
include Aws::Structure
|
|
1254
|
+
end
|
|
1255
|
+
|
|
1256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/UntagResourceOutput AWS API Documentation
|
|
1257
|
+
#
|
|
1258
|
+
class UntagResourceOutput < Aws::EmptyStructure; end
|
|
1259
|
+
|
|
1169
1260
|
# The requested action isn't valid.
|
|
1170
1261
|
#
|
|
1171
1262
|
# @!attribute [rw] message
|
|
@@ -1209,13 +1300,7 @@ module Aws::S3Vectors
|
|
|
1209
1300
|
include Aws::Structure
|
|
1210
1301
|
end
|
|
1211
1302
|
|
|
1212
|
-
#
|
|
1213
|
-
# S3 and is subject
|
|
1214
|
-
# to change.
|
|
1215
|
-
#
|
|
1216
|
-
# </note>
|
|
1217
|
-
#
|
|
1218
|
-
# The attributes of a vector bucket.
|
|
1303
|
+
# The attributes of a vector bucket.
|
|
1219
1304
|
#
|
|
1220
1305
|
# @!attribute [rw] vector_bucket_name
|
|
1221
1306
|
# The name of the vector bucket.
|
|
@@ -1244,13 +1329,7 @@ module Aws::S3Vectors
|
|
|
1244
1329
|
include Aws::Structure
|
|
1245
1330
|
end
|
|
1246
1331
|
|
|
1247
|
-
#
|
|
1248
|
-
# S3 and is subject
|
|
1249
|
-
# to change.
|
|
1250
|
-
#
|
|
1251
|
-
# </note>
|
|
1252
|
-
#
|
|
1253
|
-
# Summary information about a vector bucket.
|
|
1332
|
+
# Summary information about a vector bucket.
|
|
1254
1333
|
#
|
|
1255
1334
|
# @!attribute [rw] vector_bucket_name
|
|
1256
1335
|
# The name of the vector bucket.
|
|
@@ -1274,13 +1353,7 @@ module Aws::S3Vectors
|
|
|
1274
1353
|
include Aws::Structure
|
|
1275
1354
|
end
|
|
1276
1355
|
|
|
1277
|
-
#
|
|
1278
|
-
# S3 and is subject
|
|
1279
|
-
# to change.
|
|
1280
|
-
#
|
|
1281
|
-
# </note>
|
|
1282
|
-
#
|
|
1283
|
-
# The vector data in different formats.
|
|
1356
|
+
# The vector data in different formats.
|
|
1284
1357
|
#
|
|
1285
1358
|
# @note VectorData is a union - when making an API calls you must set exactly one of the members.
|
|
1286
1359
|
#
|
data/lib/aws-sdk-s3vectors.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -92,7 +92,12 @@ module Aws
|
|
|
92
92
|
distance_metric: ("euclidean" | "cosine"),
|
|
93
93
|
?metadata_configuration: {
|
|
94
94
|
non_filterable_metadata_keys: Array[::String]
|
|
95
|
-
}
|
|
95
|
+
},
|
|
96
|
+
?encryption_configuration: {
|
|
97
|
+
sse_type: ("AES256" | "aws:kms")?,
|
|
98
|
+
kms_key_arn: ::String?
|
|
99
|
+
},
|
|
100
|
+
?tags: Hash[::String, ::String]
|
|
96
101
|
) -> _CreateIndexResponseSuccess
|
|
97
102
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIndexResponseSuccess
|
|
98
103
|
|
|
@@ -106,7 +111,8 @@ module Aws
|
|
|
106
111
|
?encryption_configuration: {
|
|
107
112
|
sse_type: ("AES256" | "aws:kms")?,
|
|
108
113
|
kms_key_arn: ::String?
|
|
109
|
-
}
|
|
114
|
+
},
|
|
115
|
+
?tags: Hash[::String, ::String]
|
|
110
116
|
) -> _CreateVectorBucketResponseSuccess
|
|
111
117
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateVectorBucketResponseSuccess
|
|
112
118
|
|
|
@@ -217,6 +223,16 @@ module Aws
|
|
|
217
223
|
) -> _ListIndexesResponseSuccess
|
|
218
224
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIndexesResponseSuccess
|
|
219
225
|
|
|
226
|
+
interface _ListTagsForResourceResponseSuccess
|
|
227
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
|
|
228
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
229
|
+
end
|
|
230
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3Vectors/Client.html#list_tags_for_resource-instance_method
|
|
231
|
+
def list_tags_for_resource: (
|
|
232
|
+
resource_arn: ::String
|
|
233
|
+
) -> _ListTagsForResourceResponseSuccess
|
|
234
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
235
|
+
|
|
220
236
|
interface _ListVectorBucketsResponseSuccess
|
|
221
237
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListVectorBucketsOutput]
|
|
222
238
|
def next_token: () -> ::String
|
|
@@ -301,6 +317,26 @@ module Aws
|
|
|
301
317
|
?return_distance: bool
|
|
302
318
|
) -> _QueryVectorsResponseSuccess
|
|
303
319
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _QueryVectorsResponseSuccess
|
|
320
|
+
|
|
321
|
+
interface _TagResourceResponseSuccess
|
|
322
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceOutput]
|
|
323
|
+
end
|
|
324
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3Vectors/Client.html#tag_resource-instance_method
|
|
325
|
+
def tag_resource: (
|
|
326
|
+
resource_arn: ::String,
|
|
327
|
+
tags: Hash[::String, ::String]
|
|
328
|
+
) -> _TagResourceResponseSuccess
|
|
329
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
|
330
|
+
|
|
331
|
+
interface _UntagResourceResponseSuccess
|
|
332
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceOutput]
|
|
333
|
+
end
|
|
334
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3Vectors/Client.html#untag_resource-instance_method
|
|
335
|
+
def untag_resource: (
|
|
336
|
+
resource_arn: ::String,
|
|
337
|
+
tag_keys: Array[::String]
|
|
338
|
+
) -> _UntagResourceResponseSuccess
|
|
339
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
|
304
340
|
end
|
|
305
341
|
end
|
|
306
342
|
end
|