aws-sdk-s3vectors 1.9.0 → 1.10.0

data/lib/aws-sdk-s3vectors/client.rb

@@ -476,21 +476,19 @@ module Aws::S3Vectors
 
     # @!group API Operations
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Creates a vector index within a vector bucket. To specify the vector
+    # Creates a vector index within a vector bucket. To specify the vector
     # bucket, you must use either the vector bucket name or the vector
     # bucket Amazon Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:CreateIndex` permission to use this
+    # : You must have the `s3vectors:CreateIndex` permission to use this
     #   operation.
     #
+    #   You must have the `s3vectors:TagResource` permission in addition to
+    #   `s3vectors:CreateIndex` permission to create a vector index with
+    #   tags.
+    #
     # @option params [String] :vector_bucket_name
     #   The name of the vector bucket to create the vector index in.
     #
@@ -513,6 +511,27 @@ module Aws::S3Vectors
     # @option params [Types::MetadataConfiguration] :metadata_configuration
     #   The metadata configuration for the vector index.
     #
+    # @option params [Types::EncryptionConfiguration] :encryption_configuration
+    #   The encryption configuration for a vector index. By default, if you
+    #   don't specify, all new vectors in the vector index will use the
+    #   encryption configuration of the vector bucket.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   An array of user-defined tags that you would like to apply to the
+    #   vector index that you are creating. A tag is a key-value pair that you
+    #   apply to your resources. Tags can help you organize, track costs, and
+    #   control access to resources. For more information, see [Tagging for
+    #   cost allocation or attribute-based access control (ABAC)][1].
+    #
+    #   <note markdown="1"> You must have the `s3vectors:TagResource` permission in addition to
+    #   `s3vectors:CreateIndex` permission to create a vector index with tags.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
+    #
     # @return [Types::CreateIndexOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateIndexOutput#index_arn #index_arn} => String
@@ -529,6 +548,13 @@ module Aws::S3Vectors
     #     metadata_configuration: {
     #       non_filterable_metadata_keys: ["MetadataKey"], # required
     #     },
+    #     encryption_configuration: {
+    #       sse_type: "AES256", # accepts AES256, aws:kms
+    #       kms_key_arn: "KmsKeyArn",
+    #     },
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
     #   })
     #
     # @example Response structure
@@ -544,20 +570,18 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Creates a vector bucket in the Amazon Web Services Region that you
+    # Creates a vector bucket in the Amazon Web Services Region that you
     # want your bucket to be in.
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:CreateVectorBucket` permission to use
+    # : You must have the `s3vectors:CreateVectorBucket` permission to use
     #   this operation.
     #
+    #   You must have the `s3vectors:TagResource` permission in addition to
+    #   `s3vectors:CreateVectorBucket` permission to create a vector bucket
+    #   with tags.
+    #
     # @option params [required, String] :vector_bucket_name
     #   The name of the vector bucket to create.
     #
@@ -567,6 +591,23 @@ module Aws::S3Vectors
     #   server-side encryption with Amazon S3 managed keys (SSE-S3),
     #   specifically `AES256`.
     #
+    # @option params [Hash<String,String>] :tags
+    #   An array of user-defined tags that you would like to apply to the
+    #   vector bucket that you are creating. A tag is a key-value pair that
+    #   you apply to your resources. Tags can help you organize and control
+    #   access to resources. For more information, see [Tagging for cost
+    #   allocation or attribute-based access control (ABAC)][1].
+    #
+    #   <note markdown="1"> You must have the `s3vectors:TagResource` permission in addition to
+    #   `s3vectors:CreateVectorBucket` permission to create a vector bucket
+    #   with tags.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
+    #
     # @return [Types::CreateVectorBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateVectorBucketOutput#vector_bucket_arn #vector_bucket_arn} => String
@@ -579,6 +620,9 @@ module Aws::S3Vectors
     #       sse_type: "AES256", # accepts AES256, aws:kms
     #       kms_key_arn: "KmsKeyArn",
     #     },
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
     #   })
     #
     # @example Response structure
@@ -594,19 +638,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Deletes a vector index. To specify the vector index, you can either
+    # Deletes a vector index. To specify the vector index, you can either
     # use both the vector bucket name and vector index name, or use the
     # vector index Amazon Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:DeleteIndex` permission to use this
+    # : You must have the `s3vectors:DeleteIndex` permission to use this
     #   operation.
     #
     # @option params [String] :vector_bucket_name
@@ -637,20 +675,14 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Deletes a vector bucket. All vector indexes in the vector bucket must
+    # Deletes a vector bucket. All vector indexes in the vector bucket must
     # be deleted before the vector bucket can be deleted. To perform this
     # operation, you must use either the vector bucket name or the vector
     # bucket Amazon Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:DeleteVectorBucket` permission to use
+    # : You must have the `s3vectors:DeleteVectorBucket` permission to use
     #   this operation.
     #
     # @option params [String] :vector_bucket_name
@@ -677,19 +709,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Deletes a vector bucket policy. To specify the bucket, you must use
+    # Deletes a vector bucket policy. To specify the bucket, you must use
     # either the vector bucket name or the vector bucket Amazon Resource
     # Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:DeleteVectorBucketPolicy` permission to
+    # : You must have the `s3vectors:DeleteVectorBucketPolicy` permission to
     #   use this operation.
     #
     # @option params [String] :vector_bucket_name
@@ -716,19 +742,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Deletes one or more vectors in a vector index. To specify the vector
+    # Deletes one or more vectors in a vector index. To specify the vector
     # index, you can either use both the vector bucket name and vector index
     # name, or use the vector index Amazon Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:DeleteVectors` permission to use this
+    # : You must have the `s3vectors:DeleteVectors` permission to use this
     #   operation.
     #
     # @option params [String] :vector_bucket_name
@@ -764,19 +784,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Returns vector index attributes. To specify the vector index, you can
+    # 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
+    # Permissions
     #
-    # \: You must have the `s3vectors:GetIndex` permission to use this
+    # : You must have the `s3vectors:GetIndex` permission to use this
     #   operation.
     #
     # @option params [String] :vector_bucket_name
@@ -811,6 +825,8 @@ module Aws::S3Vectors
     #   resp.index.distance_metric #=> String, one of "euclidean", "cosine"
     #   resp.index.metadata_configuration.non_filterable_metadata_keys #=> Array
     #   resp.index.metadata_configuration.non_filterable_metadata_keys[0] #=> String
+    #   resp.index.encryption_configuration.sse_type #=> String, one of "AES256", "aws:kms"
+    #   resp.index.encryption_configuration.kms_key_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/GetIndex AWS API Documentation
     #
@@ -821,19 +837,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Returns vector bucket attributes. To specify the bucket, you must use
+    # Returns vector bucket attributes. To specify the bucket, you must use
     # either the vector bucket name or the vector bucket Amazon Resource
     # Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:GetVectorBucket` permission to use this
+    # : You must have the `s3vectors:GetVectorBucket` permission to use this
     #   operation.
     #
     # @option params [String] :vector_bucket_name
@@ -870,19 +880,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Gets details about a vector bucket policy. To specify the bucket, you
+    # Gets details about a vector bucket policy. To specify the bucket, you
     # must use either the vector bucket name or the vector bucket Amazon
     # Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:GetVectorBucketPolicy` permission to
+    # : You must have the `s3vectors:GetVectorBucketPolicy` permission to
     #   use this operation.
     #
     # @option params [String] :vector_bucket_name
@@ -915,20 +919,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Returns vector attributes. To specify the vector index, you can
-    # either
+    # Returns vector 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
+    # Permissions
     #
-    # \: You must have the `s3vectors:GetVectors` permission to use this
+    # : You must have the `s3vectors:GetVectors` permission to use this
     #   operation.
     #
     # @option params [String] :vector_bucket_name
@@ -982,19 +979,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Returns a list of all the vector indexes within the specified vector
+    # Returns a list of all the vector indexes within the specified vector
     # bucket. To specify the bucket, you must use either the vector bucket
     # name or the vector bucket Amazon Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:ListIndexes` permission to use this
+    # : You must have the `s3vectors:ListIndexes` permission to use this
     #   operation.
     #
     # @option params [String] :vector_bucket_name
@@ -1048,18 +1039,60 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
+    # Lists all of the tags applied to a specified Amazon S3 Vectors
+    # resource. Each tag is a label consisting of a key and value pair. Tags
+    # can help you organize, track costs for, and control access to
+    # resources.
+    #
+    # <note markdown="1"> For a list of S3 resources that support tagging, see [Managing tags
+    # for Amazon S3 resources][1].
     #
     #  </note>
     #
-    #  Returns a list of all the vector buckets that are owned by the
+    # Permissions
+    #
+    # : For vector buckets and vector indexes, you must have the
+    #   `s3vectors:ListTagsForResource` permission to use this operation.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#manage-tags
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that
+    #   you want to list tags for. The tagged resource can be a vector bucket
+    #   or a vector index.
+    #
+    # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListTagsForResourceOutput#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_tags_for_resource({
+    #     resource_arn: "ResourceARN", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/ListTagsForResource AWS API Documentation
+    #
+    # @overload list_tags_for_resource(params = {})
+    # @param [Hash] params ({})
+    def list_tags_for_resource(params = {}, options = {})
+      req = build_request(:list_tags_for_resource, params)
+      req.send_request(options)
+    end
+
+    # Returns a list of all the vector buckets that are owned by the
     # authenticated sender of the request.
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:ListVectorBuckets` permission to use
+    # : You must have the `s3vectors:ListVectorBuckets` permission to use
     #   this operation.
     #
     # @option params [Integer] :max_results
@@ -1104,24 +1137,18 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  List vectors in the specified vector index. To specify the vector
+    # List vectors in the specified vector index. 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).
     #
-    #  `ListVectors` operations proceed sequentially; however, for faster
+    # `ListVectors` operations proceed sequentially; however, for faster
     # performance on a large number of vectors in a vector index,
     # applications can request a parallel `ListVectors` operation by
     # providing the `segmentCount` and `segmentIndex` parameters.
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:ListVectors` permission to use this
+    # : You must have the `s3vectors:ListVectors` permission to use this
     #   operation. Additional permissions are required based on the request
     #   parameters you specify:
     #
@@ -1234,19 +1261,13 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Creates a bucket policy for a vector bucket. To specify the bucket,
+    # Creates a bucket policy for a vector bucket. To specify the bucket,
     # you must use either the vector bucket name or the vector bucket Amazon
     # Resource Name (ARN).
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:PutVectorBucketPolicy` permission to
+    # : You must have the `s3vectors:PutVectorBucketPolicy` permission to
     #   use this operation.
     #
     # @option params [String] :vector_bucket_name
@@ -1283,21 +1304,14 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Adds one or more vectors to a vector index. To specify the vector
+    # Adds one or more vectors to a vector index. 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).
     #
-    #  For more information about limits, see [Limitations and
+    # For more information about limits, see [Limitations and
     # restrictions][1] in the *Amazon S3 User Guide*.
     #
-    #  <note markdown="1"> When inserting vector data into your vector
-    # index, you must provide
+    # <note markdown="1"> When inserting vector data into your vector index, you must provide
     # the vector data as `float32` (32-bit floating point) values. If you
     # pass higher-precision values to an Amazon Web Services SDK, S3 Vectors
     # converts the values to 32-bit floating point before storing them, and
@@ -1310,9 +1324,9 @@ module Aws::S3Vectors
     #
     #  </note>
     #
-    #  Permissions
+    # Permissions
     #
-    # \: You must have the `s3vectors:PutVectors` permission to use this
+    # : You must have the `s3vectors:PutVectors` permission to use this
     #   operation.
     #
     #
@@ -1363,26 +1377,19 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
-    # <note markdown="1"> Amazon S3 Vectors is in preview release for Amazon
-    # S3 and is subject
-    # to change.
-    #
-    #  </note>
-    #
-    #  Performs an approximate nearest neighbor search query in a vector
+    # Performs an approximate nearest neighbor search query in a vector
     # index using a query vector. By default, it returns the keys of
     # approximate nearest neighbors. You can optionally include the computed
     # distance (between the query vector and each vector in the response),
     # the vector data, and metadata of each vector in the response.
     #
-    #  To specify the vector index, you can either use both the vector
-    # bucket
+    # 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
+    # Permissions
     #
-    # \: You must have the `s3vectors:QueryVectors` permission to use this
+    # : You must have the `s3vectors:QueryVectors` permission to use this
     #   operation. Additional permissions are required based on the request
     #   parameters you specify:
     #
@@ -1463,10 +1470,8 @@ module Aws::S3Vectors
     # @example Response structure
     #
     #   resp.vectors #=> Array
-    #   resp.vectors[0].key #=> String
-    #   resp.vectors[0].data.float32 #=> Array
-    #   resp.vectors[0].data.float32[0] #=> Float
     #   resp.vectors[0].distance #=> Float
+    #   resp.vectors[0].key #=> String
     #   resp.distance_metric #=> String, one of "euclidean", "cosine"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/QueryVectors AWS API Documentation
@@ -1478,6 +1483,108 @@ module Aws::S3Vectors
       req.send_request(options)
     end
 
+    # Applies one or more user-defined tags to an Amazon S3 Vectors resource
+    # or updates existing tags. Each tag is a label consisting of a key and
+    # value pair. Tags can help you organize, track costs for, and control
+    # access to your resources. You can add up to 50 tags for each resource.
+    #
+    # <note markdown="1"> For a list of S3 resources that support tagging, see [Managing tags
+    # for Amazon S3 resources][1].
+    #
+    #  </note>
+    #
+    # Permissions
+    #
+    # : For vector buckets and vector indexes, you must have the
+    #   `s3vectors:TagResource` permission to use this operation.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#manage-tags
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that
+    #   you're applying tags to. The tagged resource can be a vector bucket
+    #   or a vector index.
+    #
+    # @option params [required, Hash<String,String>] :tags
+    #   The user-defined tag that you want to add to the specified S3 Vectors
+    #   resource. For more information, see [Tagging for cost allocation or
+    #   attribute-based access control (ABAC)][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.tag_resource({
+    #     resource_arn: "ResourceARN", # required
+    #     tags: { # required
+    #       "TagKey" => "TagValue",
+    #     },
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/TagResource AWS API Documentation
+    #
+    # @overload tag_resource(params = {})
+    # @param [Hash] params ({})
+    def tag_resource(params = {}, options = {})
+      req = build_request(:tag_resource, params)
+      req.send_request(options)
+    end
+
+    # Removes the specified user-defined tags from an Amazon S3 Vectors
+    # resource. You can pass one or more tag keys.
+    #
+    # <note markdown="1"> For a list of S3 resources that support tagging, see [Managing tags
+    # for Amazon S3 resources][1].
+    #
+    #  </note>
+    #
+    # Permissions
+    #
+    # : For vector buckets and vector indexes, you must have the
+    #   `s3vectors:UntagResource` permission to use this operation.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#manage-tags
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that
+    #   you're removing tags from. The tagged resource can be a vector bucket
+    #   or a vector index.
+    #
+    # @option params [required, Array<String>] :tag_keys
+    #   The array of tag keys that you're removing from the S3 Vectors
+    #   resource. For more information, see [Tagging for cost allocation or
+    #   attribute-based access control (ABAC)][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.untag_resource({
+    #     resource_arn: "ResourceARN", # required
+    #     tag_keys: ["TagKey"], # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/UntagResource AWS API Documentation
+    #
+    # @overload untag_resource(params = {})
+    # @param [Hash] params ({})
+    def untag_resource(params = {}, options = {})
+      req = build_request(:untag_resource, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -1496,7 +1603,7 @@ module Aws::S3Vectors
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-s3vectors'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end