AWS.Tools.S3Vectors.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.S3Vectors</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.GetIndex </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexCmdlet.IndexArn"> <summary> <para> <para>The ARN of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexCmdlet.IndexName"> <summary> <para> <para>The name of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Index'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.GetIndexResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.GetIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.ListIndexes<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.Prefix"> <summary> <para> <para>Limits the response to vector indexes that begin with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.VectorBucketArn"> <summary> <para> <para>The ARN of the vector bucket that contains the vector indexes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector indexes. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned in the response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.NextToken"> <summary> <para> <para>The previous pagination token. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Indexes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.ListIndexesResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.ListIndexesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VectorBucketName parameter. The -PassThru parameter is deprecated, use -Select '^VectorBucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VIndexListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.GetVectors </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.IndexArn"> <summary> <para> <para>The ARN of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.IndexName"> <summary> <para> <para>The name of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.Key"> <summary> <para> <para>The names of the vectors you want to return attributes for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.ReturnData"> <summary> <para> <para>Indicates whether to include the vector data in the response. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.ReturnMetadata"> <summary> <para> <para>Indicates whether to include metadata in the response. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vectors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.GetVectorsResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.GetVectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.GetVectorBucket </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketCmdlet.VectorBucketArn"> <summary> <para> <para>The ARN of the vector bucket to retrieve information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket to retrieve information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VectorBucket'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.GetVectorBucketResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.GetVectorBucketResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VectorBucketName parameter. The -PassThru parameter is deprecated, use -Select '^VectorBucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.ListVectorBuckets<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet.Prefix"> <summary> <para> <para>Limits the response to vector buckets that begin with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of vector buckets to be returned in the response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet.NextToken"> <summary> <para> <para>The previous pagination token. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VectorBuckets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.ListVectorBucketsResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.ListVectorBucketsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Prefix parameter. The -PassThru parameter is deprecated, use -Select '^Prefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketPolicyCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.GetVectorBucketPolicy </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketPolicyCmdlet.VectorBucketArn"> <summary> <para> <para>The ARN of the vector bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketPolicyCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.GetVectorBucketPolicyResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.GetVectorBucketPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorBucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VectorBucketName parameter. The -PassThru parameter is deprecated, use -Select '^VectorBucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.ListVectors<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.IndexArn"> <summary> <para> <para>The Amazon resource Name (ARN) of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.IndexName"> <summary> <para> <para>The name of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.ReturnData"> <summary> <para> <para>If true, the vector data of each vector will be included in the response. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.ReturnMetadata"> <summary> <para> <para>If true, the metadata associated with each vector will be included in the response. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.SegmentCount"> <summary> <para> <para>For a parallel <c>ListVectors</c> request, <c>segmentCount</c> represents the total number of vector segments into which the <c>ListVectors</c> operation will be divided. The value of <c>segmentCount</c> corresponds to the number of application workers that will perform the parallel <c>ListVectors</c> operation. For example, if you want to use four application threads to list vectors in a vector index, specify a <c>segmentCount</c> value of 4. </para><para>If you specify a <c>segmentCount</c> value of 1, the <c>ListVectors</c> operation will be sequential rather than parallel.</para><para>If you specify <c>segmentCount</c>, you must also specify <c>segmentIndex</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.SegmentIndex"> <summary> <para> <para>For a parallel <c>ListVectors</c> request, <c>segmentIndex</c> 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. </para><para>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 <c>segmentIndex</c> value of 0, the second thread specifies 1, and so on. </para><para>The value of <c>segmentIndex</c> must be less than the value provided for <c>segmentCount</c>. </para><para>If you provide <c>segmentIndex</c>, you must also provide <c>segmentCount</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of vectors to return on a page.</para><para>If you don't specify <c>maxResults</c>, the <c>ListVectors</c> operation uses a default value of 500.</para><para>If the processed dataset size exceeds 1 MB before reaching the <c>maxResults</c> value, the operation stops and returns the vectors that are retrieved up to that point, along with a <c>nextToken</c> that you can use in a subsequent request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.NextToken"> <summary> <para> <para>Pagination token from a previous request. The value of this field is empty for an initial request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vectors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.ListVectorsResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.ListVectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.GetS3VVectorListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.CreateIndex </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.DataType"> <summary> <para> <para>The data type of the vectors to be inserted into the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.Dimension"> <summary> <para> <para>The dimensions of the vectors to be inserted into the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.DistanceMetric"> <summary> <para> <para>The distance metric to be used for similarity search. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.IndexName"> <summary> <para> <para>The name of the vector index to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.MetadataConfiguration_NonFilterableMetadataKey"> <summary> <para> <para>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>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.VectorBucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket to create the vector index in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.CreateIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.CreateVectorBucket </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet.EncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>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 <c>sseType</c> is set to <c>aws:kms</c>.</para><para>To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).</para><para>For example, specify Key ARN in the following format: <c>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet.EncryptionConfiguration_SseType"> <summary> <para> <para>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 <c>AES256</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.CreateVectorBucketResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VectorBucketName parameter. The -PassThru parameter is deprecated, use -Select '^VectorBucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.NewS3VVectorBucketCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.DeleteIndex </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet.IndexArn"> <summary> <para> <para>The ARN of the vector index to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet.IndexName"> <summary> <para> <para>The name of the vector index to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.DeleteIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexName parameter. The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.DeleteVectors </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet.IndexArn"> <summary> <para> <para>The ARN of the vector index that contains a vector you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet.IndexName"> <summary> <para> <para>The name of the vector index that contains a vector you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet.Key"> <summary> <para> <para>The keys of the vectors to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.DeleteVectorsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.DeleteVectorBucket </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketCmdlet.VectorBucketArn"> <summary> <para> <para>The ARN of the vector bucket to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.DeleteVectorBucketResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VectorBucketName parameter. The -PassThru parameter is deprecated, use -Select '^VectorBucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketPolicyCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.DeleteVectorBucketPolicy </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketPolicyCmdlet.VectorBucketArn"> <summary> <para> <para>The ARN of the vector bucket to delete the policy from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketPolicyCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket to delete the policy from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.DeleteVectorBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.RemoveS3VVectorBucketPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.QueryVectors </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.Filter"> <summary> <para> <para>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>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.QueryVector_Float32"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.IndexArn"> <summary> <para> <para>The ARN of the vector index that you want to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.IndexName"> <summary> <para> <para>The name of the vector index that you want to query. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.ReturnDistance"> <summary> <para> <para>Indicates whether to include the computed distance in the response. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.ReturnMetadata"> <summary> <para> <para>Indicates whether to include metadata in the response. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.TopK"> <summary> <para> <para>The number of results to return for each query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vectors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.QueryVectorsResponse). Specifying the name of a property of type Amazon.S3Vectors.Model.QueryVectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopK parameter. The -PassThru parameter is deprecated, use -Select '^TopK' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.SearchS3VVectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.PutVectors </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.IndexArn"> <summary> <para> <para>The ARN of the vector index where you want to write vectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.IndexName"> <summary> <para> <para>The name of the vector index where you want to write vectors. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket that contains the vector index. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.Vector"> <summary> <para> <para>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 <c>ServiceUnavailableException</c> with the error message "Currently unable to handle the request".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.PutVectorsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VectorBucketName parameter. The -PassThru parameter is deprecated, use -Select '^VectorBucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet"> <summary> Amazon.S3Vectors.IAmazonS3Vectors.PutVectorBucketPolicy </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet.Policy"> <summary> <para> <para>The <c>JSON</c> 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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet.VectorBucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the vector bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet.VectorBucketName"> <summary> <para> <para>The name of the vector bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Vectors.Model.PutVectorBucketPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Policy parameter. The -PassThru parameter is deprecated, use -Select '^Policy' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3V.WriteS3VVectorBucketPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |