1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. s3vectors
  5. getIndex

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.s3vectors.getIndex

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::S3Vectors::Index

    Using getIndex

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOptions): Output<GetIndexResult>
    def get_index(index_arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(index_arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
    func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

    > Note: This function is named LookupIndex in the Go SDK.

    public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:s3vectors:getIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IndexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    IndexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    indexArn String

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    indexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    index_arn str

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    indexArn String

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    getIndex Result

    The following output properties are available:

    CreationTime string

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    IndexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    User tags (key-value pairs) to associate with the index.
    CreationTime string

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    IndexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    Tags Tag
    User tags (key-value pairs) to associate with the index.
    creationTime String

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    indexArn String

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    tags List<Tag>
    User tags (key-value pairs) to associate with the index.
    creationTime string

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    indexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    tags Tag[]
    User tags (key-value pairs) to associate with the index.
    creation_time str

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    index_arn str

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    tags Sequence[root_Tag]
    User tags (key-value pairs) to associate with the index.
    creationTime String

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    indexArn String

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    tags List<Property Map>
    User tags (key-value pairs) to associate with the index.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.57.0
    published on Monday, Mar 9, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.