We recommend new projects start with resources from the AWS provider.
aws-native.s3vectors.getIndex
We recommend new projects start with resources from the AWS provider.
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 dictionaryThe following arguments are supported:
- Index
Arn 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 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 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 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
- index
Arn 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:
- Creation
Time string Returns the date and time when the vector index was created.
Example:
2024-12-21T10:30:00Z- Index
Arn 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
- Creation
Time string Returns the date and time when the vector index was created.
Example:
2024-12-21T10:30:00Z- Index
Arn 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
- creation
Time String Returns the date and time when the vector index was created.
Example:
2024-12-21T10:30:00Z- index
Arn 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
- creation
Time string Returns the date and time when the vector index was created.
Example:
2024-12-21T10:30:00Z- index
Arn 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
- 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
- creation
Time String Returns the date and time when the vector index was created.
Example:
2024-12-21T10:30:00Z- index
Arn 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
