<?php
// This file was auto-generated from sdk-root/src/data/s3vectors/2025-07-15/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for you to interact with vectors to do similarity search. Within a vector bucket, you use a vector index to organize and logically group your vector data. When you make a write or read request, you direct it to a single vector index. You store your vector data as vectors. A vector contains a key (a name that you assign), a multi-dimensional vector, and, optionally, metadata that describes a vector. The key uniquely identifies the vector in a vector index.</p>', 'operations' => [ 'CreateIndex' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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).</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:CreateIndex</code> permission to use this operation. </p> </dd> </dl></p>', 'CreateVectorBucket' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in. </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:CreateVectorBucket</code> permission to use this operation. </p> </dd> </dl></p>', 'DeleteIndex' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:DeleteIndex</code> permission to use this operation. </p> </dd> </dl></p>', 'DeleteVectorBucket' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:DeleteVectorBucket</code> permission to use this operation. </p> </dd> </dl></p>', 'DeleteVectorBucketPolicy' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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).</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:DeleteVectorBucketPolicy</code> permission to use this operation. </p> </dd> </dl></p>', 'DeleteVectors' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:DeleteVectors</code> permission to use this operation. </p> </dd> </dl></p>', 'GetIndex' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:GetIndex</code> permission to use this operation. </p> </dd> </dl></p>', 'GetVectorBucket' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Returns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:GetVectorBucket</code> permission to use this operation. </p> </dd> </dl></p>', 'GetVectorBucketPolicy' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:GetVectorBucketPolicy</code> permission to use this operation. </p> </dd> </dl></p>', 'GetVectors' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:GetVectors</code> permission to use this operation. </p> </dd> </dl></p>', 'ListIndexes' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:ListIndexes</code> permission to use this operation. </p> </dd> </dl></p>', 'ListVectorBuckets' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Returns a list of all the vector buckets that are owned by the authenticated sender of the request.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:ListVectorBuckets</code> permission to use this operation. </p> </dd> </dl></p>', 'ListVectors' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <p> <code>ListVectors</code> operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel <code>ListVectors</code> operation by providing the <code>segmentCount</code> and <code>segmentIndex</code> parameters.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:ListVectors</code> permission to use this operation. Additional permissions are required based on the request parameters you specify:</p> <ul> <li> <p>With only <code>s3vectors:ListVectors</code> permission, you can list vector keys when <code>returnData</code> and <code>returnMetadata</code> are both set to false or not specified..</p> </li> <li> <p>If you set <code>returnData</code> or <code>returnMetadata</code> to true, you must have both <code>s3vectors:ListVectors</code> and <code>s3vectors:GetVectors</code> permissions. The request fails with a <code>403 Forbidden</code> error if you request vector data or metadata without the <code>s3vectors:GetVectors</code> permission.</p> </li> </ul> </dd> </dl></p>', 'PutVectorBucketPolicy' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:PutVectorBucketPolicy</code> permission to use this operation. </p> </dd> </dl></p>', 'PutVectors' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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). </p> <p>For more information about limits, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-limitations.html">Limitations and restrictions</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>When inserting vector data into your vector index, you must provide the vector data as <code>float32</code> (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 <code>GetVectors</code>, <code>ListVectors</code>, and <code>QueryVectors</code> operations return the float32 values. Different Amazon Web Services SDKs may have different default numeric types, so ensure your vectors are properly formatted as <code>float32</code> values regardless of which SDK you\'re using. For example, in Python, use <code>numpy.float32</code> or explicitly cast your values.</p> </note> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:PutVectors</code> permission to use this operation. </p> </dd> </dl></p>', 'QueryVectors' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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. </p> <p>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). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:QueryVectors</code> permission to use this operation. Additional permissions are required based on the request parameters you specify:</p> <ul> <li> <p>With only <code>s3vectors:QueryVectors</code> permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don\'t set any metadata filters and don\'t request vector data or metadata (by keeping the <code>returnMetadata</code> parameter set to <code>false</code> or not specified).</p> </li> <li> <p>If you specify a metadata filter or set <code>returnMetadata</code> to true, you must have both <code>s3vectors:QueryVectors</code> and <code>s3vectors:GetVectors</code> permissions. The request fails with a <code>403 Forbidden error</code> if you request metadata filtering, vector data, or metadata without the <code>s3vectors:GetVectors</code> permission.</p> </li> </ul> </dd> </dl></p>', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '<p>Access denied.</p>', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'GetVectorsInput$returnData' => '<p>Indicates whether to include the vector data in the response. The default value is <code>false</code>.</p>', 'GetVectorsInput$returnMetadata' => '<p>Indicates whether to include metadata in the response. The default value is <code>false</code>.</p>', 'ListVectorsInput$returnData' => '<p>If true, the vector data of each vector will be included in the response. The default value is <code>false</code>.</p>', 'ListVectorsInput$returnMetadata' => '<p>If true, the metadata associated with each vector will be included in the response. The default value is <code>false</code>.</p>', 'QueryVectorsInput$returnMetadata' => '<p>Indicates whether to include metadata in the response. The default value is <code>false</code>.</p>', 'QueryVectorsInput$returnDistance' => '<p>Indicates whether to include the computed distance in the response. The default value is <code>false</code>.</p>', ], ], 'ConflictException' => [ 'base' => '<p>The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.</p>', 'refs' => [], ], 'CreateIndexInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateIndexOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateVectorBucketInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateVectorBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'DataType' => [ 'base' => NULL, 'refs' => [ 'CreateIndexInput$dataType' => '<p>The data type of the vectors to be inserted into the vector index. </p>', 'Index$dataType' => '<p>The data type of the vectors inserted into the vector index. </p>', ], ], 'DeleteIndexInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIndexOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVectorBucketInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVectorBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVectorBucketPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVectorBucketPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVectorsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVectorsInputList' => [ 'base' => NULL, 'refs' => [ 'DeleteVectorsInput$keys' => '<p>The keys of the vectors to delete. </p>', ], ], 'DeleteVectorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'Dimension' => [ 'base' => NULL, 'refs' => [ 'CreateIndexInput$dimension' => '<p>The dimensions of the vectors to be inserted into the vector index. </p>', 'Index$dimension' => '<p>The number of values in the vectors that are inserted into the vector index. </p>', ], ], 'DistanceMetric' => [ 'base' => NULL, 'refs' => [ 'CreateIndexInput$distanceMetric' => '<p>The distance metric to be used for similarity search. </p>', 'Index$distanceMetric' => '<p>The distance metric to be used for similarity search. </p>', ], ], 'Document' => [ 'base' => NULL, 'refs' => [ 'QueryVectorsInput$filter' => '<p>Metadata filter to apply during the query. For more information about metadata keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-metadata-filtering.html">Metadata filtering</a> in the <i>Amazon S3 User Guide</i>. </p>', ], ], 'EncryptionConfiguration' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The encryption configuration for a vector bucket. By default, if you don\'t specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p></p>', 'refs' => [ 'CreateVectorBucketInput$encryptionConfiguration' => '<p>The encryption configuration for the vector bucket. By default, if you don\'t specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>. </p>', 'VectorBucket$encryptionConfiguration' => '<p>The encryption configuration for the vector bucket.</p>', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServerException$message' => NULL, 'KmsDisabledException$message' => NULL, 'KmsInvalidKeyUsageException$message' => NULL, 'KmsInvalidStateException$message' => NULL, 'KmsNotFoundException$message' => NULL, 'NotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ServiceUnavailableException$message' => NULL, 'TooManyRequestsException$message' => NULL, ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'Float32VectorData$member' => NULL, 'QueryOutputVector$distance' => '<p>The measure of similarity between the vector in the response and the query vector.</p>', ], ], 'Float32VectorData' => [ 'base' => NULL, 'refs' => [ 'VectorData$float32' => '<p>The vector data as 32-bit floating point numbers. The number of elements in this array must exactly match the dimension of the vector index where the operation is being performed.</p>', ], ], 'GetIndexInput' => [ 'base' => NULL, 'refs' => [], ], 'GetIndexOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetOutputVector' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector returned by the <code>GetVectors</code> operation.</p></p>', 'refs' => [ 'GetVectorsOutputList$member' => NULL, ], ], 'GetVectorBucketInput' => [ 'base' => NULL, 'refs' => [], ], 'GetVectorBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetVectorBucketPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetVectorBucketPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetVectorsInput' => [ 'base' => NULL, 'refs' => [], ], 'GetVectorsInputList' => [ 'base' => NULL, 'refs' => [ 'GetVectorsInput$keys' => '<p>The names of the vectors you want to return attributes for. </p>', ], ], 'GetVectorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetVectorsOutputList' => [ 'base' => NULL, 'refs' => [ 'GetVectorsOutput$vectors' => '<p>The attributes of the vectors.</p>', ], ], 'Index' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector index.</p></p>', 'refs' => [ 'GetIndexOutput$index' => '<p>The attributes of the vector index.</p>', ], ], 'IndexArn' => [ 'base' => NULL, 'refs' => [ 'DeleteIndexInput$indexArn' => '<p>The ARN of the vector index to delete.</p>', 'DeleteVectorsInput$indexArn' => '<p>The ARN of the vector index that contains a vector you want to delete.</p>', 'GetIndexInput$indexArn' => '<p>The ARN of the vector index.</p>', 'GetVectorsInput$indexArn' => '<p>The ARN of the vector index.</p>', 'Index$indexArn' => '<p>The Amazon Resource Name (ARN) of the vector index.</p>', 'IndexSummary$indexArn' => '<p>The Amazon Resource Name (ARN) of the vector index.</p>', 'ListVectorsInput$indexArn' => '<p>The Amazon resource Name (ARN) of the vector index.</p>', 'PutVectorsInput$indexArn' => '<p>The ARN of the vector index where you want to write vectors.</p>', 'QueryVectorsInput$indexArn' => '<p>The ARN of the vector index that you want to query.</p>', ], ], 'IndexName' => [ 'base' => NULL, 'refs' => [ 'CreateIndexInput$indexName' => '<p>The name of the vector index to create. </p>', 'DeleteIndexInput$indexName' => '<p>The name of the vector index to delete. </p>', 'DeleteVectorsInput$indexName' => '<p>The name of the vector index that contains a vector you want to delete.</p>', 'GetIndexInput$indexName' => '<p>The name of the vector index.</p>', 'GetVectorsInput$indexName' => '<p>The name of the vector index.</p>', 'Index$indexName' => '<p>The name of the vector index.</p>', 'IndexSummary$indexName' => '<p>The name of the vector index.</p>', 'ListVectorsInput$indexName' => '<p>The name of the vector index.</p>', 'PutVectorsInput$indexName' => '<p>The name of the vector index where you want to write vectors. </p>', 'QueryVectorsInput$indexName' => '<p>The name of the vector index that you want to query. </p>', ], ], 'IndexSummary' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Summary information about a vector index.</p></p>', 'refs' => [ 'ListIndexesOutputList$member' => NULL, ], ], 'InternalServerException' => [ 'base' => '<p>The request failed due to an internal server error.</p>', 'refs' => [], ], 'KmsDisabledException' => [ 'base' => '<p>The specified Amazon Web Services KMS key isn\'t enabled.</p>', 'refs' => [], ], 'KmsInvalidKeyUsageException' => [ 'base' => '<p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (<code>KeySpec</code>).</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">InvalidKeyUsageException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>', 'refs' => [], ], 'KmsInvalidStateException' => [ 'base' => '<p>The key state of the KMS key isn\'t compatible with the operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">KMSInvalidStateException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsKeyArn' => '<p>Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if <code>sseType</code> is set to <code>aws:kms</code>.</p> <p>To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).</p> <p>For example, specify Key ARN in the following format: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>', ], ], 'KmsNotFoundException' => [ 'base' => '<p>The KMS key can\'t be found.</p>', 'refs' => [], ], 'ListIndexesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListIndexesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListIndexesInput$maxResults' => '<p>The maximum number of items to be returned in the response. </p>', ], ], 'ListIndexesNextToken' => [ 'base' => NULL, 'refs' => [ 'ListIndexesInput$nextToken' => '<p>The previous pagination token. </p>', 'ListIndexesOutput$nextToken' => '<p>The next pagination token.</p>', ], ], 'ListIndexesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListIndexesOutputList' => [ 'base' => NULL, 'refs' => [ 'ListIndexesOutput$indexes' => '<p>The attributes of the vector indexes</p>', ], ], 'ListIndexesPrefix' => [ 'base' => NULL, 'refs' => [ 'ListIndexesInput$prefix' => '<p>Limits the response to vector indexes that begin with the specified prefix.</p>', ], ], 'ListOutputVector' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector returned by the <code>ListVectors</code> operation.</p></p>', 'refs' => [ 'ListVectorsOutputList$member' => NULL, ], ], 'ListVectorBucketsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListVectorBucketsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListVectorBucketsInput$maxResults' => '<p>The maximum number of vector buckets to be returned in the response. </p>', ], ], 'ListVectorBucketsNextToken' => [ 'base' => NULL, 'refs' => [ 'ListVectorBucketsInput$nextToken' => '<p>The previous pagination token. </p>', 'ListVectorBucketsOutput$nextToken' => '<p>The element is included in the response when there are more buckets to be listed with pagination. </p>', ], ], 'ListVectorBucketsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListVectorBucketsOutputList' => [ 'base' => NULL, 'refs' => [ 'ListVectorBucketsOutput$vectorBuckets' => '<p>The list of vector buckets owned by the requester. </p>', ], ], 'ListVectorBucketsPrefix' => [ 'base' => NULL, 'refs' => [ 'ListVectorBucketsInput$prefix' => '<p>Limits the response to vector buckets that begin with the specified prefix.</p>', ], ], 'ListVectorsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListVectorsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListVectorsInput$maxResults' => '<p>The maximum number of vectors to return on a page.</p> <p>If you don\'t specify <code>maxResults</code>, the <code>ListVectors</code> operation uses a default value of 500.</p> <p>If the processed dataset size exceeds 1 MB before reaching the <code>maxResults</code> value, the operation stops and returns the vectors that are retrieved up to that point, along with a <code>nextToken</code> that you can use in a subsequent request to retrieve the next set of results.</p>', ], ], 'ListVectorsNextToken' => [ 'base' => NULL, 'refs' => [ 'ListVectorsInput$nextToken' => '<p>Pagination token from a previous request. The value of this field is empty for an initial request.</p>', 'ListVectorsOutput$nextToken' => '<p>Pagination token to be used in the subsequent request. The field is empty if no further pagination is required.</p>', ], ], 'ListVectorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListVectorsOutputList' => [ 'base' => NULL, 'refs' => [ 'ListVectorsOutput$vectors' => '<p>Vectors in the current segment.</p>', ], ], 'ListVectorsSegmentCount' => [ 'base' => NULL, 'refs' => [ 'ListVectorsInput$segmentCount' => '<p>For a parallel <code>ListVectors</code> request, <code>segmentCount</code> represents the total number of vector segments into which the <code>ListVectors</code> operation will be divided. The value of <code>segmentCount</code> corresponds to the number of application workers that will perform the parallel <code>ListVectors</code> operation. For example, if you want to use four application threads to list vectors in a vector index, specify a <code>segmentCount</code> value of 4. </p> <p>If you specify a <code>segmentCount</code> value of 1, the <code>ListVectors</code> operation will be sequential rather than parallel.</p> <p>If you specify <code>segmentCount</code>, you must also specify <code>segmentIndex</code>.</p>', ], ], 'ListVectorsSegmentIndex' => [ 'base' => NULL, 'refs' => [ 'ListVectorsInput$segmentIndex' => '<p>For a parallel <code>ListVectors</code> request, <code>segmentIndex</code> is the index of the segment from which to list vectors in the current request. It identifies an individual segment to be listed by an application worker. </p> <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to list vectors in a vector index, then the first thread specifies a <code>segmentIndex</code> value of 0, the second thread specifies 1, and so on. </p> <p>The value of <code>segmentIndex</code> must be less than the value provided for <code>segmentCount</code>. </p> <p>If you provide <code>segmentIndex</code>, you must also provide <code>segmentCount</code>.</p>', ], ], 'MetadataConfiguration' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The metadata configuration for a vector index.</p></p>', 'refs' => [ 'CreateIndexInput$metadataConfiguration' => '<p>The metadata configuration for the vector index. </p>', 'Index$metadataConfiguration' => '<p>The metadata configuration for the vector index. </p>', ], ], 'MetadataKey' => [ 'base' => NULL, 'refs' => [ 'NonFilterableMetadataKeys$member' => NULL, ], ], 'NonFilterableMetadataKeys' => [ 'base' => NULL, 'refs' => [ 'MetadataConfiguration$nonFilterableMetadataKeys' => '<p>Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys can’t be used as query filters. Non-filterable metadata keys can be retrieved but can’t be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors. For more information about non-filterable metadata keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-vectors.html">Vectors</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-limitations.html">Limitations and restrictions</a> in the <i>Amazon S3 User Guide</i>. </p>', ], ], 'NotFoundException' => [ 'base' => '<p>The request was rejected because the specified resource can\'t be found.</p>', 'refs' => [], ], 'PutInputVector' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector to add to a vector index.</p></p>', 'refs' => [ 'PutVectorsInputList$member' => NULL, ], ], 'PutVectorBucketPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutVectorBucketPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutVectorsInput' => [ 'base' => NULL, 'refs' => [], ], 'PutVectorsInputList' => [ 'base' => NULL, 'refs' => [ 'PutVectorsInput$vectors' => '<p>The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error <code>ServiceUnavailableException</code> with the error message "Currently unable to handle the request".</p>', ], ], 'PutVectorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'QueryOutputVector' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector in the approximate nearest neighbor search.</p></p>', 'refs' => [ 'QueryVectorsOutputList$member' => NULL, ], ], 'QueryVectorsInput' => [ 'base' => NULL, 'refs' => [], ], 'QueryVectorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'QueryVectorsOutputList' => [ 'base' => NULL, 'refs' => [ 'QueryVectorsOutput$vectors' => '<p>The vectors in the approximate nearest neighbor search.</p>', ], ], 'ServiceQuotaExceededException' => [ 'base' => '<p>Your request exceeds a service quota. </p>', 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => '<p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>', 'refs' => [], ], 'SseType' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$sseType' => '<p>The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don\'t specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ValidationException$message' => NULL, 'ValidationExceptionField$path' => '<p>A path about the validation exception.</p>', 'ValidationExceptionField$message' => '<p>A message about the validation exception.</p>', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Index$creationTime' => '<p>Date and time when the vector index was created. </p>', 'IndexSummary$creationTime' => '<p>Date and time when the vector index was created. </p>', 'VectorBucket$creationTime' => '<p>Date and time when the vector bucket was created. </p>', 'VectorBucketSummary$creationTime' => '<p>Date and time when the vector bucket was created. </p>', ], ], 'TooManyRequestsException' => [ 'base' => '<p>The request was denied due to request throttling.</p>', 'refs' => [], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'QueryVectorsInput$topK' => '<p>The number of results to return for each query.</p>', ], ], 'ValidationException' => [ 'base' => '<p>The requested action isn\'t valid.</p>', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '<p>Contains information about a validation exception.</p>', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => '<p>A list of specific validation failures that are encountered during input processing. Each entry in the list contains a path to the field that failed validation and a detailed message that explains why the validation failed. To satisfy multiple constraints, a field can appear multiple times in this list if it failed. You can use the information to identify and fix the specific validation issues in your request.</p>', ], ], 'VectorBucket' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector bucket. </p></p>', 'refs' => [ 'GetVectorBucketOutput$vectorBucket' => '<p>The attributes of the vector bucket.</p>', ], ], 'VectorBucketArn' => [ 'base' => NULL, 'refs' => [ 'CreateIndexInput$vectorBucketArn' => '<p>The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.</p>', 'DeleteVectorBucketInput$vectorBucketArn' => '<p>The ARN of the vector bucket to delete.</p>', 'DeleteVectorBucketPolicyInput$vectorBucketArn' => '<p>The ARN of the vector bucket to delete the policy from.</p>', 'GetVectorBucketInput$vectorBucketArn' => '<p>The ARN of the vector bucket to retrieve information about.</p>', 'GetVectorBucketPolicyInput$vectorBucketArn' => '<p>The ARN of the vector bucket.</p>', 'ListIndexesInput$vectorBucketArn' => '<p>The ARN of the vector bucket that contains the vector indexes.</p>', 'PutVectorBucketPolicyInput$vectorBucketArn' => '<p>The Amazon Resource Name (ARN) of the vector bucket.</p>', 'VectorBucket$vectorBucketArn' => '<p>The Amazon Resource Name (ARN) of the vector bucket. </p>', 'VectorBucketSummary$vectorBucketArn' => '<p>The Amazon Resource Name (ARN) of the vector bucket. </p>', ], ], 'VectorBucketName' => [ 'base' => NULL, 'refs' => [ 'CreateIndexInput$vectorBucketName' => '<p>The name of the vector bucket to create the vector index in. </p>', 'CreateVectorBucketInput$vectorBucketName' => '<p>The name of the vector bucket to create. </p>', 'DeleteIndexInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'DeleteVectorBucketInput$vectorBucketName' => '<p>The name of the vector bucket to delete.</p>', 'DeleteVectorBucketPolicyInput$vectorBucketName' => '<p>The name of the vector bucket to delete the policy from.</p>', 'DeleteVectorsInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'GetIndexInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'GetVectorBucketInput$vectorBucketName' => '<p>The name of the vector bucket to retrieve information about.</p>', 'GetVectorBucketPolicyInput$vectorBucketName' => '<p>The name of the vector bucket.</p>', 'GetVectorsInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'Index$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'IndexSummary$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'ListIndexesInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector indexes. </p>', 'ListVectorsInput$vectorBucketName' => '<p>The name of the vector bucket. </p>', 'PutVectorBucketPolicyInput$vectorBucketName' => '<p>The name of the vector bucket.</p>', 'PutVectorsInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'QueryVectorsInput$vectorBucketName' => '<p>The name of the vector bucket that contains the vector index. </p>', 'VectorBucket$vectorBucketName' => '<p>The name of the vector bucket. </p>', 'VectorBucketSummary$vectorBucketName' => '<p>The name of the vector bucket. </p>', ], ], 'VectorBucketPolicy' => [ 'base' => NULL, 'refs' => [ 'GetVectorBucketPolicyOutput$policy' => '<p>The <code>JSON</code> that defines the policy.</p>', 'PutVectorBucketPolicyInput$policy' => '<p>The <code>JSON</code> that defines the policy. For more information about bucket policies for S3 Vectors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-bucket-policy.html">Managing vector bucket policies</a> in the <i>Amazon S3 User Guide</i>.</p>', ], ], 'VectorBucketSummary' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Summary information about a vector bucket.</p></p>', 'refs' => [ 'ListVectorBucketsOutputList$member' => NULL, ], ], 'VectorData' => [ 'base' => '<p><note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The vector data in different formats.</p></p>', 'refs' => [ 'GetOutputVector$data' => '<p>The vector data of the vector. </p>', 'ListOutputVector$data' => '<p>The vector data of the vector. </p>', 'PutInputVector$data' => '<p>The vector data of the vector. </p> <p>Vector dimensions must match the dimension count that\'s configured for the vector index.</p> <ul> <li> <p>For the <code>cosine</code> distance metric, zero vectors (vectors containing all zeros) aren\'t allowed.</p> </li> <li> <p>For both <code>cosine</code> and <code>euclidean</code> distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren\'t allowed.</p> </li> </ul>', 'QueryOutputVector$data' => '<p>The vector data associated with the vector, if requested. </p>', 'QueryVectorsInput$queryVector' => '<p>The query vector. Ensure that the query vector has the same dimension as the dimension of the vector index that\'s being queried. For example, if your vector index contains vectors with 384 dimensions, your query vector must also have 384 dimensions. </p>', ], ], 'VectorKey' => [ 'base' => NULL, 'refs' => [ 'DeleteVectorsInputList$member' => NULL, 'GetOutputVector$key' => '<p>The name of the vector. </p>', 'GetVectorsInputList$member' => NULL, 'ListOutputVector$key' => '<p>The name of the vector. </p>', 'PutInputVector$key' => '<p>The name of the vector. The key uniquely identifies the vector in a vector index. </p>', 'QueryOutputVector$key' => '<p>The key of the vector in the approximate nearest neighbor search.</p>', ], ], 'VectorMetadata' => [ 'base' => NULL, 'refs' => [ 'GetOutputVector$metadata' => '<p>Metadata about the vector. </p>', 'ListOutputVector$metadata' => '<p>Metadata about the vector. </p>', 'PutInputVector$metadata' => '<p>Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.</p>', 'QueryOutputVector$metadata' => '<p>The metadata associated with the vector, if requested.</p>', ], ], ],];
